Skip to content
Console
On this page

Open a profile

Mounts a profile for one session: returns the state of one version and, for WRITE_BACK, an attachment that `:commit` writes through until it…

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.

Mounts a profile for one session: returns the state of one version and, for WRITE_BACK, an attachment that :commit writes through until it expires. Every call is audited with the caller's context; the caller's principal needs a grant of at least the requested mode.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/profiles/profile:open
  • Scope secrets:mount
  • Effect read — nothing is written.
  • Collection profiles

Request

FieldTypeWhat it is
namestringThe profile to mount. Required.
modeProfileMountModeREAD_ONLY (the default) or WRITE_BACK. One of read_only, write_back.
versionstringA version to mount; unset mounts the latest.
ttldurationHow long a WRITE_BACK attachment may commit; default 1 hour, at most 12 hours. A lost session cannot write back after it.
contextmap<string, string>Who mounts it, for the audit trail: for example run, step, member. At most 16 entries; keys and values are names, never values.

Response

FieldTypeWhat it is
attachmentstringThe attachment this mount is recorded as; :commit takes it.
versionstringThe version mounted; empty when the profile has none yet.
modeProfileMountModeThe mode granted. One of read_only, write_back.
statebytesThe profile's state: for a browser profile the Playwright storageState JSON document, for a computer profile the archive of its declared paths. Empty when the profile has no version yet. Never returned again.
expire_timetimestampWhen a WRITE_BACK attachment stops accepting commits.
sitesProfileSite[]The sites in the state and when each last changed.

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:open" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'