Secrets


GET /{o}/{p}/secrets/values

Which secrets have a value set

One row per declared secret: its name and whether a value has ever been stored for it. Never the value, and never the description — read declarations from GET /catalog?kind=Secret.

Auth: Bearer token required · Permission: secrets:read

Path parameters

NameTypeDescription
ostring
pstring

Responses

StatusDescriptionSchema
200OKSecretValueStatusList
401UnauthorizedError
403ForbiddenError

GET /{o}/{p}/secrets/{name}/value

Whether one secret has a value set

The read mirror of PUT at this same path: whether a value has been stored, never what it is.

Auth: Bearer token required · Permission: secrets:read

Path parameters

NameTypeDescription
ostring
pstring
namestring

Responses

StatusDescriptionSchema
200OKSecretValueStatus
401UnauthorizedError
403ForbiddenError
404Not FoundError

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

Set a secret value

Encrypt and store the secret value at rest. Requires the secrets:set-value permission.

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

Path parameters

NameTypeDescription
ostring
pstring
namestring

Request body (application/json)

FieldTypeDescription
valuestringSecret value (required)

Responses

StatusDescriptionSchema
200OKobject
401UnauthorizedError
403ForbiddenError
404Not FoundError

Schemas

Error

FieldTypeDescription
errorstring(required)
codestring

SecretValueStatus

FieldTypeDescription
namestring(required)
hasValuebooleanWhether PUT /secrets/:name/value has ever succeeded for this secret (required)
updatedAtstring | string | null(required)

SecretValueStatusList

Type: SecretValueStatus[]