Skip to main content
API docs by Redocly

Secrets API (v1.0)

Managing secrets

Secrets

List all secrets

Authorizations:
X-Auth-Token
query Parameters
list
required
boolean

Required parameter with any value for listing secrets

Responses

Delete secret

Authorizations:
X-Auth-Token
path Parameters
secret_name
required
string

Secret's name

Responses

Get secret

Authorizations:
X-Auth-Token
path Parameters
secret_name
required
string

Secret's name

Responses

Create new secret

Authorizations:
X-Auth-Token
path Parameters
secret_name
required
string

Secret's name

Request Body schema: application/json
required

Payload

description
string

Optional description of secret

value
string <base64>

Value of secret encoded in base64

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "value": "dmFsdWU="
}

Update secret description

Authorizations:
X-Auth-Token
path Parameters
secret_name
required
string

Secret's name

Request Body schema: application/json
required

Payload

description
string

New description of secret

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}