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
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 · int32RequiredDefault:
Number of results to return per page, between 1 and 1000. Default 250.
250
pageinteger · int32RequiredDefault:
Page number to return, 0-indexed. Default 0.
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
GET /api/v1/catalog/definitions HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"definitions": [
{
"description": "text",
"name": "text",
"schema": {},
"source": "CORTEX",
"type": "text"
}
],
"page": 1,
"total": 1,
"totalPages": 1
}
Authorizations
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
GET /api/v1/catalog/definitions/{type} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"description": "text",
"name": "text",
"schema": {},
"source": "CORTEX",
"type": "text"
}
Authorizations
Body
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
POST /api/v1/catalog/definitions HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"description": "text",
"name": "text",
"schema": {},
"type": "text"
}
{
"description": "text",
"name": "text",
"schema": {},
"source": "CORTEX",
"type": "text"
}
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
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
PUT /api/v1/catalog/definitions/{type} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 48
{
"description": "text",
"name": "text",
"schema": {}
}
{
"description": "text",
"name": "text",
"schema": {},
"source": "CORTEX",
"type": "text"
}
Authorizations
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
DELETE /api/v1/catalog/definitions/{type} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?