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

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

includeBuiltInbooleanOptional

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

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 found entity types

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/catalog/definitions

HTTPcURLJavaScriptPython

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

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

Retrieve entity type

get

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

typestringRequired

Responses

200

Successfully found entity types

application/json

404

Entity type 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/catalog/definitions/{type}

HTTPcURLJavaScriptPython

GET /api/v1/catalog/definitions/{type} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create entity type

post

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

descriptionstringOptional

namestringOptional

schemaobjectRequired

typestringRequired

Responses

200

Successfully created entity type

application/json

400

Failed to create entity type

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/catalog/definitions

HTTPcURLJavaScriptPython

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

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

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

Update entity type

put

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

typestringRequired

Query parameters

forcebooleanOptional

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

Body

application/json

descriptionstringOptional

namestringOptional

schemaobjectRequired

Responses

200

Successfully updated entity type

application/json

400

Failed to update entity type

application/json

404

Entity type 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/catalog/definitions/{type}

HTTPcURLJavaScriptPython

PUT /api/v1/catalog/definitions/{type} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "description": "text",
  "name": "text",
  "schema": {}
}

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

Delete entity type

delete

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

typestringRequired

Responses

200

Successfully deleted entity type

404

Entity type 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/catalog/definitions/{type}

HTTPcURLJavaScriptPython

DELETE /api/v1/catalog/definitions/{type} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content