GET /{o}/{p}/envs/{envName}/secretsList 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
| Name | Type | Description |
|---|---|---|
o | string | |
p | string | |
envName | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Secrets (metadata only) | SecretList |
POST /{o}/{p}/envs/{envName}/secretsCreate a secret
Declare a secret (metadata only). Set its value via PUT /:name/value.
Auth: Bearer token required · Permission:
secrets:write
Path parameters
| Name | Type | Description |
|---|---|---|
o | string | |
p | string | |
envName | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
kind | Secret | (required) |
name | string | (required) |
description | string |
Responses
| Status | Description | Schema |
|---|---|---|
201 | Created secret | Secret |
409 | Secret already exists | Error |
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
| Name | Type | Description |
|---|---|---|
o | string | |
p | string | |
envName | string | |
name | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | The secret (metadata only) | Secret |
404 | Secret not found | Error |
PUT /{o}/{p}/envs/{envName}/secrets/{name}Update a secret description
Auth: Bearer token required · Permission:
secrets:write
Path parameters
| Name | Type | Description |
|---|---|---|
o | string | |
p | string | |
envName | string | |
name | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
kind | Secret | (required) |
name | string | (required) |
description | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Updated secret | Secret |
404 | Secret not found | Error |
DELETE /{o}/{p}/envs/{envName}/secrets/{name}Delete a secret
Auth: Bearer token required · Permission:
secrets:write
Path parameters
| Name | Type | Description |
|---|---|---|
o | string | |
p | string | |
envName | string | |
name | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Deletion result | Deleted |
404 | Secret not found | Error |
PUT /{o}/{p}/envs/{envName}/secrets/{name}/valueSet 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
| Name | Type | Description |
|---|---|---|
o | string | |
p | string | |
envName | string | |
name | string |
Request body (application/json)
| Field | Type | Description |
|---|---|---|
value | string | (required) |
Responses
| Status | Description | Schema |
|---|---|---|
200 | Value set | object |
404 | Secret not found | Error |
Deleted| Field | Type | Description |
|---|---|---|
deleted | true | (required) |
name | string | (required) |
Error| Field | Type | Description |
|---|---|---|
error | string | (required) |
code | string |
Secret| Field | Type | Description |
|---|---|---|
name | string | (required) |
description | string,null | (required) |
hasValue | boolean | (required) |
createdAt | string | string | (required) |
updatedAt | string | string | (required) |
SecretListType: Secret[]