Docs

Use these operations to interact with external docs on entities in Cortex.

Required permissions

Your API key must have the Edit entities permission.

Operations

Retrieve OpenAPI docs for entity

get

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

namestringoptional

Name of the OpenAPI spec to return. If you have multiple OpenAPI specs configured for your entity as x-cortex-links, use this parameter to ensure the correct spec is returned. If this parameter is not specified, we will return the first OpenAPI spec found.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

429

200

{
  "spec": "text"
}

Successfully found documentation

Update OpenAPI docs for entity

put

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

specstringrequired

Stringified JSON representation of the OpenAPI spec

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/documentation/openapi' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "spec": "text"
  }'

200

400

429

200

{
  "spec": "text"
}

Successfully updated documentation

Delete OpenAPI docs for entity

delete

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Responses

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

204

429

204

No body

Successfully deleted documentation