Skip to content

Get performance metrics

GET
/clusters/{cluster_id}/insights/performance
curl --request GET \
  --url 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/insights/performance?realm=customer-portal' \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta'

Returns CPU utilization, JVM heap usage, response time percentiles, garbage collection overhead, and live thread count.

When neither start_time nor end_time is provided the window covers the last 24 hours.

Required scope: clusters:insights:read

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
cluster_id
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
realm

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

string
>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/

Example 

customer-portal

Restrict metrics to a specific realm.

start_time
string format: date-time

Inclusive start time (ISO 8601). Defaults to 24 hours ago when omitted.

end_time
string format: date-time

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

Header Parameters

Section titled “Header Parameters”
API-Version
required
string
Allowed values: 2026-06-01.beta

Responses

Section titled “Responses”

200

Section titled “200”

The request has succeeded.

Media typeapplication/json

System performance metrics over the requested time window.

object
response_times
required

Response time statistics for authentication endpoints.

object
average
required
object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
p50
required
object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
p95
required
object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
p99
required
object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
by_endpoint
required

Per-endpoint breakdown for the top auth endpoints by request volume.

Array<object>

Performance summary for a single authentication endpoint.

object
endpoint
required

Endpoint path pattern.

string
count
required
integer format: int64
avg_time
required

Mean response time, in milliseconds.

number format: double
p95_time
required

95th percentile response time, in milliseconds.

number format: double
memory_usage
required

JVM heap usage as a percentage (0–100).

object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
cpu_usage
required

Mean CPU utilization across all pods (0–100+, may exceed 100 on multi-core systems).

object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
max_cpu_usage
required

Peak CPU utilization across all pods.

object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
garbage_collection
required

JVM garbage collection overhead.

object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double
thread_count
required

Live JVM thread count.

object
values
required
Array<object>
object
timestamp
required
string format: date-time
value
required
number format: double

Example 

{
  "response_times": {
    "by_endpoint": [
      {
        "endpoint": "/realms/{realm}/protocol/openid-connect/token"
      }
    ]
  }
}

400

Section titled “400”

The server could not understand the request due to invalid syntax.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

401

Section titled “401”

Access is unauthorized.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

403

Section titled “403”

Access is forbidden.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

404

Section titled “404”

The server cannot find the requested resource.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

422

Section titled “422”

Client error

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
errors
required
Array<object>
>= 1 items
object
field
required
string
detail
required
string
code
string
value

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "errors": [
    {
      "field": "example",
      "detail": "example",
      "code": "example",
      "value": "example"
    }
  ]
}

429

Section titled “429”

Client error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Headers

Section titled “Headers”
Retry-After
integer
RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer
X-RateLimit-Limit-Second
integer
X-RateLimit-Remaining-Second
integer
X-RateLimit-Limit-Minute
integer
X-RateLimit-Remaining-Minute
integer
X-RateLimit-Limit-Hour
integer
X-RateLimit-Remaining-Hour
integer
X-RateLimit-Limit-Day
integer
X-RateLimit-Remaining-Day
integer

500

Section titled “500”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

501

Section titled “501”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}
© 2026 Skycloak. All Rights Reserved. Design by Yasser SolimanKeycloak™ is a trademark of the Linux Foundation. Skycloak is not affiliated with the Keycloak project.