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

List artifact references

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

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

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/artifact_references
  • Scope artifacts:read
  • Effect read — nothing is written.
  • Collection artifact_references
  • Query page_size, page_token, filter
  • Pagination the answer carries artifact_references and, when there is more, next_page_token

#Request

FieldTypeWhat it is
parentstringThe environment holding this retention declaration. Required.
page_sizeint32Maximum results; defaults to 50 and is capped at 1000.
page_tokenstringThe next_page_token of the preceding page with the same parameters.
filterstringA filter on repository, digest or holder_kind, using the List filter grammar.

#Response

FieldTypeWhat it is
artifact_referencesArtifactReference[]The matching holder references, ordered by name.
next_page_tokenstringEmpty when this is the final page.

#ArtifactReference

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.
  • INVALID_FIELD — A field failed validation.
  • PAGE_TOKEN_MISMATCH — A page token was reused with different parameters.
  • 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" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"