List custom events for entity

GET 
/api/v1/catalog/:tagOrId/custom-events

List custom events for entity

Request

Path Parameters

tagOrId stringrequired

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

Query Parameters

type string
timestamp date-time
pageSize int32

Number of results to return per page. (Note: If no "pageSize" value is provided, the endpoint will attempt to return all custom events.)

page int32

Default value: 0

Page number to return, 0-indexed.

Responses

200

Successfully retrieved custom events

*/*

Schema

Schema

events

object[]

required

Array [

customData

object

Optional property to store additional data

property name* object

Optional property to store additional data

description string

Optional description of custom event

timestamp date-timerequired

Time when event occurred

title stringrequired

Name for custom event

type stringrequired

Type of custom event

url string

Optional URL associated with custom event

uuid uuidrequired

Automatically generated identifier

]

page int32required

Current page number, 0-indexed

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "events": [
    {
      "customData": {},
      "description": "string",
      "timestamp": "2024-07-26T07:05:08.141Z",
      "title": "Created K8s pod",
      "type": "POD_CREATION",
      "url": "https://cortex.io",
      "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
    }
  ],
  "page": 0,
  "total": 0,
  "totalPages": 0
}

400

Bad Request

*/*

Schema

Schema

events

object[]

required

Array [

customData

object

Optional property to store additional data

property name* object

Optional property to store additional data

description string

Optional description of custom event

timestamp date-timerequired

Time when event occurred

title stringrequired

Name for custom event

type stringrequired

Type of custom event

url string

Optional URL associated with custom event

uuid uuidrequired

Automatically generated identifier

]

page int32required

Current page number, 0-indexed

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "events": [
    {
      "customData": {},
      "description": "string",
      "timestamp": "2024-07-26T07:05:08.141Z",
      "title": "Created K8s pod",
      "type": "POD_CREATION",
      "url": "https://cortex.io",
      "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
    }
  ],
  "page": 0,
  "total": 0,
  "totalPages": 0
}

404

Entity not found

*/*

Schema

Schema

events

object[]

required

Array [

customData

object

Optional property to store additional data

property name* object

Optional property to store additional data

description string

Optional description of custom event

timestamp date-timerequired

Time when event occurred

title stringrequired

Name for custom event

type stringrequired

Type of custom event

url string

Optional URL associated with custom event

uuid uuidrequired

Automatically generated identifier

]

page int32required

Current page number, 0-indexed

total int32required

Total number of results

totalPages int32required

Total number of pages

Example (from schema)

{
  "events": [
    {
      "customData": {},
      "description": "string",
      "timestamp": "2024-07-26T07:05:08.142Z",
      "title": "Created K8s pod",
      "type": "POD_CREATION",
      "url": "https://cortex.io",
      "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
    }
  ],
  "page": 0,
  "total": 0,
  "totalPages": 0
}

Loading...