Skip to content
Console
On this page

Commit a profile

Writes a mounted profile back as a new version, by compare-and-set on the version the attachment was opened at (or last committed).

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Writes a mounted profile back as a new version, by compare-and-set on the version the attachment was opened at (or last committed). When another write landed first, nothing is lost: the result is still a new version, merged site by site with the newer write winning, and marked as a conflict.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles/profile:commit
  • Scope secrets:mount
  • Effect write — a successful call changes state.
  • Collection profiles

Request

FieldTypeWhat it is
namestringThe profile to write back. Required.
attachmentstringThe attachment OpenProfile returned with WRITE_BACK. Required.
statebytesThe whole state to write, in the profile kind's form, at most 2 MiB. Required. Never returned again.

Response

FieldTypeWhat it is
profile_versionProfileVersionThe version written.
conflictboolTrue when another write landed after this attachment's base: the version holds both, merged site by site with this write winning the sites it changed.

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 -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles/profile:commit" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"attachment":"…","state":"…"}'