Cluster Events

Export cluster events

Exports matching events as a CSV file. Returns 422 if the query matches more than 10,000 events or the date range exceeds 90 days — narrow the filters or date range and retry.

Required scope: clusters:events:read

get/clusters/{cluster_id}/events/export

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/events/export
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required

Query parameters

category'user' | 'admin' required

Keycloak event category.

Filter by event category.

start_timestring date-time

Inclusive start time (ISO 8601).

end_timestring date-time

Inclusive end time (ISO 8601).

realmstring

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

Example:customer-portal

Filter by realm name.

realm_idstring uuid

Filter by realm UUID.

client_idsstring[]

Filter by one or more OAuth2 client IDs.

user_idstring uuid

Filter by Keycloak user UUID.

usernamestring

Filter by username prefix.

typesUserEventType[]

Filter by event type. Accepts multiple values. Mutually exclusive with operation_types.

operation_typesAdminOperationType[]

Filter by admin operation type. Accepts multiple values. Mutually exclusive with types.

errorstring

Filter by error code.

searchstring

Substring search across username, client_id, realm_name, and ip_address.

order'asc' | 'desc'

Sort direction.

Sort order by timestamp. Defaults to desc (newest first).

Headers

API-Version'2026-06-01.beta' required

Response

The request has succeeded.

Changes

No recorded changes to this operation across all 1 revision of this API.