Secrets


GET /{o}/{p}/envs/{envName}/secrets

List secrets

List secret names in this environment. The encrypted value is never returned — only whether one is set (hasValue).

Auth: Bearer token required · Permission: secrets:read

Path parameters

NameTypeDescription
ostring
pstring
envNamestring

Responses

StatusDescriptionSchema
200Secrets (metadata only)SecretList

POST /{o}/{p}/envs/{envName}/secrets

Create a secret

Declare a secret (metadata only). Set its value via PUT /:name/value.

Auth: Bearer token required · Permission: secrets:write

Path parameters

NameTypeDescription
ostring
pstring
envNamestring

Request body (application/json)

FieldTypeDescription
kindSecret(required)
namestring(required)
descriptionstring

Responses

StatusDescriptionSchema
201Created secretSecret
409Secret already existsError

GET /{o}/{p}/envs/{envName}/secrets/{name}

Get a secret by name

Returns secret metadata only — never the encrypted value.

Auth: Bearer token required · Permission: secrets:read

Path parameters

NameTypeDescription
ostring
pstring
envNamestring
namestring

Responses

StatusDescriptionSchema
200The secret (metadata only)Secret
404Secret not foundError

PUT /{o}/{p}/envs/{envName}/secrets/{name}

Update a secret description

Auth: Bearer token required · Permission: secrets:write

Path parameters

NameTypeDescription
ostring
pstring
envNamestring
namestring

Request body (application/json)

FieldTypeDescription
kindSecret(required)
namestring(required)
descriptionstring

Responses

StatusDescriptionSchema
200Updated secretSecret
404Secret not foundError

DELETE /{o}/{p}/envs/{envName}/secrets/{name}

Delete a secret

Auth: Bearer token required · Permission: secrets:write

Path parameters

NameTypeDescription
ostring
pstring
envNamestring
namestring

Responses

StatusDescriptionSchema
200Deletion resultDeleted
404Secret not foundError

PUT /{o}/{p}/envs/{envName}/secrets/{name}/value

Set a secret value

Encrypt and store the secret value at rest. Requires the secrets:set-value permission (owner-only).

Auth: Bearer token required · Permission: secrets:set-value

Path parameters

NameTypeDescription
ostring
pstring
envNamestring
namestring

Request body (application/json)

FieldTypeDescription
valuestring(required)

Responses

StatusDescriptionSchema
200Value setobject
404Secret not foundError

Schemas

Deleted

FieldTypeDescription
deletedtrue(required)
namestring(required)

Error

FieldTypeDescription
errorstring(required)
codestring

Secret

FieldTypeDescription
namestring(required)
descriptionstring,null(required)
hasValueboolean(required)
createdAtstring | string(required)
updatedAtstring | string(required)

SecretList

Type: Secret[]