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

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Query parameters

pageSizeinteger · int32Required

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

Default: 250

pageinteger · int32Required

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

Default: 0

Responses

200

Successfully retrieved secrets

application/json

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/secrets

HTTPcURLJavaScriptPython

GET /api/v1/secrets?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Retrieve secret

get

API key must have the Create secrets permission.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

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

Responses

200

Successfully retrieved secret

application/json

404

Secret not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/secrets/{tagOrId}

HTTPcURLJavaScriptPython

GET /api/v1/secrets/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create secret

post

API key must have the Create secrets permission.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Body

application/json

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

200

Successfully created secret

application/json

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/secrets

HTTPcURLJavaScriptPython

POST /api/v1/secrets HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

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

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

Update secret

put

API key must have the Create secrets permission.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

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

Body

application/json

namestringOptional

Human-readable name for the secret

Example: My Secret

secretstringOptional

Value of the secret

Example: my-secret-password

Responses

200

Successfully updated secret

application/json

400

Bad Request

application/json

404

Secret not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/secrets/{tagOrId}

HTTPcURLJavaScriptPython

PUT /api/v1/secrets/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "My Secret",
  "secret": "my-secret-password"
}

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

Delete secret

delete

API key must have the Create secrets permission.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

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

Responses

200

Secret successfully deleted

No content

400

Bad Request

application/json

404

Secret not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/secrets/{tagOrId}

HTTPcURLJavaScriptPython

DELETE /api/v1/secrets/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content