Update custom event by UUID

PUT 
/api/v1/catalog/:tagOrId/custom-events/:uuid

Update custom event by UUID

Request

Path Parameters

tagOrId stringrequired

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

uuid uuidrequired

application/json

Body

required

customData

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

Responses

200

Successfully updated custom event

application/json

Schema

Schema

customData

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

Example (from schema)

{
  "customData": {},
  "description": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

400

Bad Request

application/json

Schema

Schema

customData

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

Example (from schema)

{
  "customData": {},
  "description": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

404

Entity or custom event not found

application/json

Schema

Schema

customData

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

Example (from schema)

{
  "customData": {},
  "description": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "title": "Created K8s pod",
  "type": "POD_CREATION",
  "url": "https://cortex.io",
  "uuid": "d853c6e0-1bca-40bf-a264-db5d4ee38d77"
}

Loading...