Skip to content
Console
On this page

Secrets

A Secret is a named, versioned value that a third party accepts only as a bearer string.

A Secret is a named, versioned value that a third party accepts only as a bearer string. Its versions hold the values; its bindings deliver them.

Service Sylphx Secrets · Resource type secrets.sylphx.com/Secret · Name pattern orgs/{org}/projects/{project}/envs/{env}/secrets/{secret} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/secrets/{secret}.
uidstringsec_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specSecretSpecDesired state. Required.
statusSecretStatusObserved 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 a secret.
GETlistLists secrets in an environment.
POSTcreateCreates a secret, without a value; add one with CreateSecretVersion.
PATCHupdateUpdates a secret.
DELETEdeleteDeletes a secret. App environment secrets are retired without erasing retained versions or changing already released configurations.

get

Gets a secret.

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

list

Lists secrets in an environment.

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

create

Creates a secret, without a value; add one with CreateSecretVersion.

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

update

Updates a secret.

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

delete

Deletes a secret. App environment secrets are retired without erasing retained versions or changing already released configurations.

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