Skip to content
Console
On this page

Create a profile

Creates an empty profile; its first version is written by a write-back mount (`:open` with WRITE_BACK, then `:commit`).

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.

Creates an empty profile; its first version is written by a write-back mount (:open with WRITE_BACK, then :commit).

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

Request

FieldTypeWhat it is
parentstringThe environment to create in. Required.
profileProfileThe profile to create; only spec is read. Required.
profile_idstringThe id of the new profile, ^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$; the server assigns one when empty.
validate_onlyboolValidate and return the result without writing anything.

Profile

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/profiles/{profile}.
metaResourceMetaResource metadata.
specProfileSpecDesired state. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

ProfileSpec

FieldTypeWhat it is
kindProfileKindWhat the profile holds. Required. One of browser, computer.
grantsProfileGrant[]Who may mount it and how. A principal with no grant cannot mount it, whatever its scopes.
pathsstring[]For a computer profile: the paths under the sandbox's home directory its archive holds, for example .config/app.

ProfileGrant

FieldTypeWhat it is
principalstringThe Access principal, as its keys carry it (for example a service account's id). Required.
modeProfileMountModeThe most it may mount: READ_ONLY, or WRITE_BACK (which includes READ_ONLY). Required. One of read_only, write_back.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/profiles/{profile}.
uidstringpfl_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specProfileSpecDesired state. Required.
statusProfileStatusObserved state. 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.

ProfileSpec

FieldTypeWhat it is
kindProfileKindWhat the profile holds. Required. One of browser, computer.
grantsProfileGrant[]Who may mount it and how. A principal with no grant cannot mount it, whatever its scopes.
pathsstring[]For a computer profile: the paths under the sandbox's home directory its archive holds, for example .config/app.

ProfileStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready. Output only.
latest_versionstringThe newest version; empty until the first write-back. Output only.
sitesProfileSite[]The sites of the latest version and when each last changed. Output only.

ProfileGrant

FieldTypeWhat it is
principalstringThe Access principal, as its keys carry it (for example a service account's id). Required.
modeProfileMountModeThe most it may mount: READ_ONLY, or WRITE_BACK (which includes READ_ONLY). Required. One of read_only, write_back.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status 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" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"kind":"browser"}}'