Custom Events
Use these operations to interact with custom events 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.
Use 'startTime' instead
If provided, events with greater than or equal to timestamp will be returned (a date-time without a time-zone in the ISO-8601 calendar system)
If provided, events with less than or equal to timestamp will be returned (a date-time without a time-zone in the ISO-8601 calendar system)
Number of results to return per page, between 1 and 1000. Default 250.
250
Page number to return, 0-indexed. Default 0.
0
Successfully retrieved custom events
Bad 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.
GET /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"events": [
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"description": "text",
"timestamp": "2025-08-07T15:16:10.718Z",
"title": "Created K8s pod",
"type": "POD_CREATION",
"url": "https://cortex.io",
"uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}
],
"page": 1,
"total": 1,
"totalPages": 1
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Successfully retrieved custom event
Bad Request
Entity or custom event 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-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"description": "text",
"timestamp": "2025-08-07T15:16:10.718Z",
"title": "Created K8s pod",
"type": "POD_CREATION",
"url": "https://cortex.io",
"uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Optional description of custom event
Time when event occurred
Name for custom event
Created K8s pod
Type of custom event
POD_CREATION
Optional URL associated with custom event
https://cortex.io
Successfully created custom event
Bad 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-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 179
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"description": "text",
"timestamp": "2025-08-07T15:16:10.718Z",
"title": "Created K8s pod",
"type": "POD_CREATION",
"url": "https://cortex.io"
}
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"description": "text",
"timestamp": "2025-08-07T15:16:10.718Z",
"title": "Created K8s pod",
"type": "POD_CREATION",
"url": "https://cortex.io",
"uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Optional description of custom event
Time when event occurred
Name for custom event
Created K8s pod
Type of custom event
POD_CREATION
Optional URL associated with custom event
https://cortex.io
Successfully updated custom event
Bad Request
Entity or custom event not found
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/{tagOrId}/custom-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 179
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"description": "text",
"timestamp": "2025-08-07T15:16:10.718Z",
"title": "Created K8s pod",
"type": "POD_CREATION",
"url": "https://cortex.io"
}
{
"customData": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"description": "text",
"timestamp": "2025-08-07T15:16:10.718Z",
"title": "Created K8s pod",
"type": "POD_CREATION",
"url": "https://cortex.io",
"uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Use 'startTime' instead
If provided, events with greater than or equal to timestamp will be deleted (a date-time without a time-zone in the ISO-8601 calendar system)
If provided, events with less than or equal to timestamp will be deleted (a date-time without a time-zone in the ISO-8601 calendar system)
Successfully deleted custom events
No Content
Bad 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.
DELETE /api/v1/catalog/{tagOrId}/custom-events HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
The tag (x-cortex-tag
) or unique, auto-generated identifier for the entity.
Successfully deleted custom event
No Content
Bad Request
Entity or custom event 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-events/{uuid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?