Docs

Use these operations to interact with in Cortex.

Required permissions

Your API key must have the Edit entities permission.

Operations

Last updated 1 month ago

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

get

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

{
  "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

delete

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

No content

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

put

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"
}