Cluster Logs

List application logs

Returns Keycloak application logs for the cluster, sorted by created_at (newest first by default).

When neither start_time nor end_time is provided the query covers the last hour. The maximum date range is 90 days. Requests outside the log retention window return an empty result set.

Required scope: clusters:logs:read

get/clusters/{cluster_id}/logs

Request

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

Path parameters

cluster_idstring uuid required

Query parameters

limitinteger

Maximum number of results to return.

offsetinteger

Number of results to skip from the start.

level'info' | 'warn' | 'error' | 'debug'
start_timestring date-time

Inclusive start time (ISO 8601). Defaults to one hour ago when omitted.

end_timestring date-time

Inclusive end time (ISO 8601). Defaults to the current time when omitted.

searchstring

Case-insensitive substring match on message.

categorystring

Filter by fully-qualified Java package or class name.

thread_namestring

Filter by thread name.

order'asc' | 'desc'

Sort direction.

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

Headers

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

Response

The request has succeeded.

timestampstring date-time required
level'info' | 'warn' | 'error' | 'debug' required
messagestring required
sourcestring required

Keycloak logger or component that produced this entry.

categorystring required

Fully-qualified Java package or class name.

thread_namestring required

Normalized Keycloak thread name.

Example response

[
  {
    "category": "org.keycloak.events",
    "thread_name": "executor-thread-1"
  }
]

Changes

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