Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Profile versions

A ProfileVersion is one immutable, encrypted state of a Profile.

A ProfileVersion is one immutable, encrypted state of a Profile.

Service Sylphx Secrets · Resource type secrets.sylphx.com/ProfileVersion · Name pattern orgs/{org}/projects/{project}/envs/{env}/profiles/{profile}/profile_versions/{profile_version} · Shape record

#Fields

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.

#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
GETgetGets a profile version: its sites and lineage; never a value.
GETlistLists a profile's versions, newest first.

#get

Gets a profile version: its sites and lineage; never a value.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles/profile/profile_versions/profile-version · scope secrets:read · effect read · Request, response and examples

#list

Lists a profile's versions, newest first.

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