OPopenshift
events

GET /v2/events

Lists events for a cluster.

Request

  • Base URL
    http://api.openshift.com/api/assisted-install
  • URL
    http://api.openshift.com/api/assisted-install/v2/events
  • Auth
    • API key in header Authorization
    • or API key in query parameter api_key
    • or API key in header Watcher-Authorization

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.

Changes

No recorded changes to this operation across all 54 revisions of this API.