Secrets

Use these operations to interact with secrets in Cortex.

Required permissions

• Your API key must have the Create secrets permission.

List secrets

get

API key must have the Create secrets permission.

Authorizations

Query parameters

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/secrets?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "page": 1,
  "secrets": [
    {
      "id": "se2da8159dbeefb974",
      "name": "My Secret",
      "tag": "my-secret"
    }
  ],
  "total": 1,
  "totalPages": 1
}

Successfully retrieved secrets

Retrieve secret

get

API key must have the Create secrets permission.

Authorizations

Path parameters

tagOrIdstringrequired

The specified secret tag or unique, auto-generated identifier for the secret.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/secrets/{tagOrId}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "id": "se2da8159dbeefb974",
  "name": "My Secret",
  "tag": "my-secret"
}

Successfully retrieved secret

Create secret

post

API key must have the Create secrets permission.

Authorizations

Body

namestringrequired

Human-readable name for the secret

Example: My Secret

secretstringrequired

Value of the secret

Example: my-secret-password

tagstringrequired

Unique identifier for the secret

Example: my-secret

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/secrets' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My Secret",
    "secret": "my-secret-password",
    "tag": "my-secret"
  }'

200

400

429

200

{
  "id": "se2da8159dbeefb974",
  "name": "My Secret",
  "tag": "my-secret"
}

Successfully created secret

Update secret

put

API key must have the Create secrets permission.

Authorizations

Path parameters

tagOrIdstringrequired

The specified secret tag or unique, auto-generated identifier for the secret.

Body

namestringoptional

Human-readable name for the secret

Example: My Secret

secretstringoptional

Value of the secret

Example: my-secret-password

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/secrets/{tagOrId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My Secret",
    "secret": "my-secret-password"
  }'

200

400

404

429

200

{
  "id": "se2da8159dbeefb974",
  "name": "My Secret",
  "tag": "my-secret"
}

Successfully updated secret

Delete secret

delete

API key must have the Create secrets permission.

Authorizations

Path parameters

tagOrIdstringrequired

The specified secret tag or unique, auto-generated identifier for the secret.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/secrets/{tagOrId}' \
  --header 'Authorization: Bearer JWT'

200

400

404

429

200

No body

Secret successfully deleted