Custom Data (Advanced)
Use this endpoint when attempting to delete custom data where the key contains non-alphanumeric characters. Otherwise, use the standard API under Custom Data
.
Authorizations
Query parameters
tagstringRequired
Entity tag (x-cortex-tag), supports non-alphanumeric characters
keystringOptional
When set, returns the entity's value at this key. Otherwise, returns all custom data key/values for the entity.
Responses
200
Successfully retrieved custom data
application/json
404
Entity 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/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
[
{
"dateUpdated": "2025-06-29T14:57:01.513Z",
"description": "text",
"id": 1,
"key": "text",
"source": "YAML",
"value": {}
}
]
Authorizations
Query parameters
tagstringRequired
forcebooleanOptional
When true, overrides values that were defined in the catalog descriptor. Will be overwritten the next time the catalog descriptor is processed.
Body
descriptionstringOptional
keystringRequiredExample:
Custom data key for the entity
my-key
Responses
200
Successfully created data
application/json
400
Invalid custom data request
application/json
404
Entity 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
post
POST /api/v1/catalog/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-06-29T14:57:01.513Z",
"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
.
Authorizations
Query parameters
tagstringRequired
keystringRequired
forcebooleanOptional
Responses
200
Successfully deleted custom data
404
Entity 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/custom-data HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?