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

200

Successfully found documentation

application/json

404

Documentation 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

HTTPcURLJavaScriptPython

GET /api/v1/catalog/{tagOrId}/documentation/openapi HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "spec": "text"
}

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

200

Successfully updated documentation

application/json

400

Invalid 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

put

HTTPcURLJavaScriptPython

PUT /api/v1/catalog/{tagOrId}/documentation/openapi HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "spec": "text"
}

{
  "spec": "text"
}

Delete OpenAPI docs for entity

delete

Authorizations

Path parameters

tagOrIdstringRequired

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

Responses

204

Successfully deleted documentation

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

HTTPcURLJavaScriptPython

DELETE /api/v1/catalog/{tagOrId}/documentation/openapi HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content