Custom Data
Use these operations to interact with custom data in Cortex.
Required permissions
Edit entities: Your API key must have the Edit entities permission.
Operations
The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Number of results to return per page, between 1 and 1000. Default 250.
250Page number to return, 0-indexed. Default 0.
0Successfully retrieved custom data. If using pagination, we do not return page, total, or totalPages in the response. An empty array is returned once you reach the end.
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/catalog/{tagOrId}/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
[
{
"dateUpdated": "2025-09-16T18:59:43.230Z",
"description": "text",
"id": 1,
"key": "text",
"source": "YAML",
"value": {}
}
]Use this endpoint when attempting to delete custom data where the key contains non-alphanumeric characters. Otherwise, use the standard API under Custom Data.
Entity tag (x-cortex-tag), supports non-alphanumeric characters
When set, returns the entity's value at this key. Otherwise, returns all custom data key/values for the entity.
Successfully retrieved custom data
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/catalog/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
[
{
"dateUpdated": "2025-09-16T18:59:43.230Z",
"description": "text",
"id": 1,
"key": "text",
"source": "YAML",
"value": {}
}
]The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
Successfully retrieved custom data for key
Custom data not found for given entity and key
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/catalog/{tagOrId}/custom-data/{key} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"dateUpdated": "2025-09-16T18:59:43.230Z",
"description": "text",
"id": 1,
"key": "text",
"source": "YAML",
"value": {}
}The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
When true, overrides values that were defined in the catalog descriptor. Will be overwritten the next time the catalog descriptor is processed.
Custom data key for the entity
my-keySuccessfully created data
Invalid custom data request
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/catalog/{tagOrId}/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"description": "text",
"key": "my-key",
"value": {
"nested": {
"objects": "are ok"
}
}
}{
"dateUpdated": "2025-09-16T18:59:43.230Z",
"description": "text",
"id": 1,
"key": "text",
"source": "YAML",
"value": {}
}Refer to the Webhook section of the Custom Data docs for more information. This API is preconfigured in your workspace settings under Custom Integrations. The UUID corresponds to a custom data key, as well as a jq command that maps the data in this payload to an entity in your workspace.
OK
No content
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/custom-integrations/data/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2
{}No content
Add multiple key/values of custom data to multiple entities
When true, overrides values that were defined in the catalog descriptor. Will be overwritten the next time the catalog descriptor is processed.
Successfully created/updated custom data
Invalid custom data request
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
PUT /api/v1/catalog/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 215
{
"values": {
"another-service-tag": [
{
"key": "different-key",
"value": {
"nested": "object"
}
},
{
"key": "my-cool-key",
"value": "Hello again"
}
],
"service-x": [
{
"key": "my-key",
"value": 100
},
{
"key": "my-second-key",
"value": "Hello"
}
]
}
}{
"errors": {
"ANY_ADDITIONAL_PROPERTY": "NOT_FOUND"
},
"values": [
{
"dateUpdated": "2025-09-16T18:59:43.230Z",
"description": "text",
"id": 1,
"key": "text",
"source": "YAML",
"value": {}
}
]
}The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.
When true, overrides values that were defined in the catalog descriptor. Will be overwritten the next time the catalog descriptor is processed.
Successfully deleted custom data
No content
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/catalog/{tagOrId}/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Use this endpoint when attempting to delete custom data where the key contains non-alphanumeric characters. Otherwise, use the standard API under Custom Data.
Successfully deleted custom data
No content
Entity not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/catalog/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?