Skip to content
Cloud
Docs

Secrets API reference

Project-scoped write-only runtime secrets.

Published contracts: @socra/secret-api@0.0.1.

Base URL

https://secret.socra.cloud

Secrets

A project-owned write-only runtime secret identity.

Create secret

POST/v1/secrets

Request body

project_idcustomrequired
namestringrequired
min length: 1 · max length: 63 · pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$
descriptionstring | nulloptional
default: null

Response

8 fields

idcustomrequired
project_idcustomrequired
namestringrequired
min length: 1 · max length: 63 · pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$
descriptionstring | nullrequired
status"active" | "disabled"required
latest_versioninteger | nullrequired
created_atcustomrequired
updated_atcustomrequired

List secrets

GET/v1/secrets

Query parameters

project_idcustomrequired
status"active" | "disabled"optional
limitintegeroptional
min: 1 · max: 100
afterstringoptional

Response

2 fields

dataobject[]required
idcustomrequired
project_idcustomrequired
namestringrequired
min length: 1 · max length: 63 · pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$
descriptionstring | nullrequired
status"active" | "disabled"required
latest_versioninteger | nullrequired
created_atcustomrequired
updated_atcustomrequired
has_morebooleanrequired

Get secret

GET/v1/secrets/{id}

Path parameters

idcustomrequired

Query parameters

No query parameters

Response

8 fields

idcustomrequired
project_idcustomrequired
namestringrequired
min length: 1 · max length: 63 · pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$
descriptionstring | nullrequired
status"active" | "disabled"required
latest_versioninteger | nullrequired
created_atcustomrequired
updated_atcustomrequired

Update secret

PATCH/v1/secrets/{id}

Path parameters

idcustomrequired

Request body

descriptionstring | nulloptional
status"active" | "disabled"optional

Response

8 fields

idcustomrequired
project_idcustomrequired
namestringrequired
min length: 1 · max length: 63 · pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$
descriptionstring | nullrequired
status"active" | "disabled"required
latest_versioninteger | nullrequired
created_atcustomrequired
updated_atcustomrequired

Delete secret

DELETE/v1/secrets/{id}

Path parameters

idcustomrequired

Query parameters

No query parameters

Response

No response body

Secret versions

Immutable write-only secret material metadata. Values are never returned.

Add secret version

POST/v1/secret-versions

Request body

secret_idcustomrequired
valuestringrequired
min length: 1 · max length: 4096

Response

5 fields

idcustomrequired
secret_idcustomrequired
numberintegerrequired
greater than: 0 · max: 9007199254740991
status"enabled" | "disabled"required
created_atcustomrequired

List secret versions

GET/v1/secret-versions

Query parameters

secret_idcustomrequired
limitintegeroptional
min: 1 · max: 100
afterstringoptional

Response

2 fields

dataobject[]required
idcustomrequired
secret_idcustomrequired
numberintegerrequired
greater than: 0 · max: 9007199254740991
status"enabled" | "disabled"required
created_atcustomrequired
has_morebooleanrequired

Get secret version

GET/v1/secret-versions/{id}

Path parameters

idcustomrequired

Query parameters

No query parameters

Response

5 fields

idcustomrequired
secret_idcustomrequired
numberintegerrequired
greater than: 0 · max: 9007199254740991
status"enabled" | "disabled"required
created_atcustomrequired

Update secret version

PATCH/v1/secret-versions/{id}

Path parameters

idcustomrequired

Request body

status"enabled" | "disabled"required

Response

5 fields

idcustomrequired
secret_idcustomrequired
numberintegerrequired
greater than: 0 · max: 9007199254740991
status"enabled" | "disabled"required
created_atcustomrequired