Custom Events

Last updated 6 hours ago

List custom events for entity

get

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

typestringoptional

timestampstring · date-timeoptionalDeprecated

Use 'startTime' instead

startTimestring · date-timeoptional

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)

endTimestring · date-timeoptional

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)

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/custom-events?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

400

404

429

{
  "events": [
    {
      "customData": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "description": "text",
      "timestamp": "2025-03-29T00:36:41.784Z",
      "title": "Created K8s pod",
      "type": "POD_CREATION",
      "url": "https://cortex.io",
      "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Successfully retrieved custom events

Retrieve custom event by UUID

get

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidrequired

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/custom-events/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

404

429

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-03-29T00:36:41.784Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Successfully retrieved custom event

Delete ALL custom events for an entity

delete

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

typestringoptional

timestampstring · date-timeoptionalDeprecated

Use 'startTime' instead

startTimestring · date-timeoptional

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)

endTimestring · date-timeoptional

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)

Responses

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/custom-events' \
  --header 'Authorization: Bearer JWT'

200

204

400

404

429

No body

Successfully deleted custom events

Delete custom events by UUID

delete

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidrequired

Responses

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/custom-events/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

204

400

404

429

No body

Successfully deleted custom event

Create custom event for entity

post

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

customDataobjectoptional

Optional property to store additional data

descriptionstringoptional

Optional description of custom event

timestampstring · date-timerequired

Time when event occurred

titlestringrequired

Name for custom event

Example: Created K8s pod

typestringrequired

Type of custom event

Example: POD_CREATION

urlstringoptional

Optional URL associated with custom event

Example: https://cortex.io

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/custom-events' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "customData": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "description": "text",
    "timestamp": "2025-03-29T00:36:41.784Z",
    "title": "Created K8s pod",
    "type": "POD_CREATION",
    "url": "https://cortex.io"
  }'

200

400

404

429

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-03-29T00:36:41.784Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Successfully created custom event

Update custom event by UUID

put

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

uuidstring · uuidrequired

Body

customDataobjectoptional

Optional property to store additional data

descriptionstringoptional

Optional description of custom event

timestampstring · date-timerequired

Time when event occurred

titlestringrequired

Name for custom event

Example: Created K8s pod

typestringrequired

Type of custom event

Example: POD_CREATION

urlstringoptional

Optional URL associated with custom event

Example: https://cortex.io

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/custom-events/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "customData": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "description": "text",
    "timestamp": "2025-03-29T00:36:41.784Z",
    "title": "Created K8s pod",
    "type": "POD_CREATION",
    "url": "https://cortex.io"
  }'

200

400

404

429

{
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "description": "text",
  "timestamp": "2025-03-29T00:36:41.784Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Successfully updated custom event

Custom Events

Custom Events

Required permissions

Operations

Required permissions

Operations

List custom events for entity

Retrieve custom event by UUID

Delete ALL custom events for an entity

Delete custom events by UUID

Create custom event for entity

Update custom event by UUID

Required permissions

Operations

Required permissions

Operations

List custom events for entity

Retrieve custom event by UUID

Delete ALL custom events for an entity

Delete custom events by UUID

Create custom event for entity

Show child attributes

Update custom event by UUID

Show child attributes