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

Get an artifact reference

Gets an exact holder reference, including its current expiry.

Gets an exact holder reference, including its current expiry.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference
  • Scope artifacts:read
  • Effect read — nothing is written.
  • Collection artifact_references

#Request

FieldTypeWhat it is
namestringThe exact reference to read. Required.

#Response

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.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

  • UNAUTHENTICATED — No valid key or token was presented.
  • PERMISSION_DENIED — The key lacks the method's permission.
  • RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
  • UNAVAILABLE — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references/artifact-reference" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"