v52

latestSwagger 2.0Apache 2.0raw.githubusercontent.com2026-08-0381182251.7 KB
events

Lists events for a cluster.

get/v2/events

Query parameters

cluster_idstring uuid

The cluster to return events for.

host_idstring uuid

A host in the specified cluster to return events for (DEPRECATED. Use host_ids instead).

host_idsstring[]

Hosts in the specified cluster to return events for.

infra_env_idstring uuid

The infra-env to return events for.

limitinteger

The maximum number of records to retrieve.

offsetinteger

Number of records to skip before starting to return the records.

order'ascending' | 'descending'

Order by event_time of events retrieved.

severitiesstring[]

Retrieved events severities.

messagestring

Retrieved events message pattern.

deleted_hostsboolean

Deleted hosts flag.

cluster_levelboolean

Cluster level events flag.

categoriesstring[]

A comma-separated list of event categories.

Response

Success.

namestring

Event Name.

cluster_idstring uuid nullable

Unique identifier of the cluster this event relates to.

host_idstring uuid nullable

Unique identifier of the host this event relates to.

infra_env_idstring uuid nullable

Unique identifier of the infra-env this event relates to.

severity'info' | 'warning' | 'error' | 'critical' required
category'user' | 'metrics'
messagestring required
event_timestring date-time required
request_idstring uuid

Unique identifier of the request that caused this event to occur.

propsstring

Additional properties for the event in JSON format.