Entity Types

Use these operations to interact with entity types in Cortex.

Required permissions

Your API key must have the Edit entity types permission.

Operations

List entity types

get

List entity types

Response excludes Cortex default types of service, domain, and team.

Authorizations

Query parameters

includeBuiltInbooleanoptional

When true, returns the built-in entity types that Cortex provides, such as rds and s3. Defaults to false.

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/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

429

200

{
  "definitions": [
    {
      "description": "text",
      "name": "text",
      "schema": {},
      "source": "CORTEX",
      "type": "text"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Successfully found entity types

Retrieve entity type

get

Authorizations

Path parameters

typestringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

429

200

{
  "description": "text",
  "name": "text",
  "schema": {},
  "source": "CORTEX",
  "type": "text"
}

Successfully found entity types

Create entity type

post

Authorizations

Body

descriptionstringoptional

namestringoptional

schemaobjectrequired

typestringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/catalog/definitions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "name": "text",
    "schema": {},
    "type": "text"
  }'

200

400

429

200

{
  "description": "text",
  "name": "text",
  "schema": {},
  "source": "CORTEX",
  "type": "text"
}

Successfully created entity type

Update entity type

put

Authorizations

Path parameters

typestringrequired

Query parameters

forcebooleanoptional

When true, schema will be updated even if it results in broken schemas for existing entities. Defaults to false.

Body

descriptionstringoptional

namestringoptional

schemaobjectrequired

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/catalog/definitions/{type}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "name": "text",
    "schema": {}
  }'

200

400

404

429

200

{
  "description": "text",
  "name": "text",
  "schema": {},
  "source": "CORTEX",
  "type": "text"
}

Successfully updated entity type

Delete entity type

delete

Authorizations

Path parameters

typestringrequired

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

429

200

No body

Successfully deleted entity type