Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Artifact references

A holder's retention declaration for an exact repository and digest.

A holder's retention declaration for an exact repository and digest. The server verifies an owned Artifact receipt and a pullable protection tag before admitting it. Its lifetime is independent of the producing service.

Service Sylphx Artifacts · Resource type artifacts.sylphx.com/ArtifactReference · Name pattern orgs/{org}/projects/{project}/envs/{env}/artifact_references/{artifact_reference} · Shape record

#Fields

FieldTypeWhat it is
namestringThe canonical reference name; derived from the image and holder identity.
uidstringThe immutable reference identity. Output only.
metaResourceMetaCreation metadata. Output only.
repositorystringThe exact managed registry repository, without host, tag or digest.
digeststringThe exact algorithm-qualified SHA-256 image digest.
holder_kindstringThe kind of holding resource, for example device_state.
holder_idstringThe holding resource's stable identity within this environment.
expires_attimestampKeep this image until this instant. Repeating Update only extends it. Required.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
PATCHupdateUpdates a holder's retention reference, or creates it with allow_missing. Existing expiry is only extended, never shortened. The exact repository and digest must have an owned Artifact receipt. Success means the registry protection tag has been written and read back; a failed pin attempt commits no reference. Concurrent updates never shorten retention.
GETlistLists this environment's holder references, including expired references.
GETgetGets an exact holder reference, including its current expiry.
DELETEdeleteReleases this holder's reference. Other holders keep their protection; registry reconciliation removes a stale tag only after every root expires. Releasing an already absent reference succeeds.

#update

Updates a holder's retention reference, or creates it with allow_missing. Existing expiry is only extended, never shortened. The exact repository and digest must have an owned Artifact receipt. Success means the registry protection tag has been written and read back; a failed pin attempt commits no reference. Concurrent updates never shorten retention.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference · scope artifacts:retain · effect write · Request, response and examples

#list

Lists this environment's holder references, including expired references.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references · scope artifacts:read · effect read · paginated · Request, response and examples

#get

Gets an exact holder reference, including its current expiry.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference · scope artifacts:read · effect read · Request, response and examples

#delete

Releases this holder's reference. Other holders keep their protection; registry reconciliation removes a stale tag only after every root expires. Releasing an already absent reference succeeds.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference · scope artifacts:retain · effect destructive · Request, response and examples