Skip to content
Console
On this page

Envs

An Environment is a deployment target inside a Project (production, preview, dev,...).

An Environment is a deployment target inside a Project (production, preview, dev,...). Its mode decides which keys may touch it.

Service Sylphx Access · Resource type access.sylphx.com/Environment · Name pattern orgs/{org}/projects/{project}/envs/{env} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}.
uidstringenv_<cell><ulid>; equals the name segment. Output only.
metaResourceMetaResource metadata.
specEnvironmentSpecDesired state. Required.
statusEnvironmentStatusObserved state. 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 an environment.
GETlistLists environments in a project.
POSTcreateCreates an environment. Access assigns the id.
PATCHupdateUpdates an environment.
DELETEdeleteDeletes an environment.

get

Gets an environment.

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

list

Lists environments in a project.

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

create

Creates an environment. Access assigns the id.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs · scope access:admin · effect write · Request, response and examples

update

Updates an environment.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production · scope access:admin · effect write · Request, response and examples

delete

Deletes an environment.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production · scope access:admin · effect destructive · Request, response and examples