Skip to content
Console
Menu

Getting Started

Authentication

KV Store

List profile versions

Lists a profile's versions, newest first.

Lists a profile's versions, newest first.

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

#Request

FieldTypeWhat it is
parentstringThe profile whose versions to list. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.

#Response

FieldTypeWhat it is
profile_versionsProfileVersion[]The page, newest first.
next_page_tokenstringThe token of the next page; empty on the last page.

#ProfileVersion

FieldTypeWhat it is
namestring…/profiles/{profile}/profile_versions/{profile_version}; the id is the version number, from 1.
uidstringpflv_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
sitesProfileSite[]The sites it holds and when each last changed. Output only.
base_versionstringThe version the write was based on; empty for a first write. Output only.
conflict_versionstringSet when another version landed after the base: that version, whose sites this one kept where this write did not change them. Output only.
size_bytesint64The size of the state, in bytes. Output only.

#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.

#ProfileSite

FieldTypeWhat it is
sitestringThe registrable domain (eTLD+1), for example example.com; for a computer profile, one declared path. Output only.
update_timetimestampWhen this site's record last changed. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles/profile/profile_versions" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"