List cluster features

GET

/cluster-features

curl --request GET \
  --url http://localhost:8000/cluster-features \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta'

• Local development

Returns the catalog of Keycloak feature flags that can be toggled on tenant clusters.

Authorizations

• ApiKeyAuth

Parameters

Header Parameters

API-Version

required

string

Allowed values: 2026-06-01.beta

Responses

200

The request has succeeded.

Media typeapplication/json

Array<object>

Metadata about a Keycloak feature flag available for tenant clusters.

object

name

required

Feature flag identifier as used in the features and features_disabled cluster fields.

string

display_name

required

Human-readable feature name.

string

description

required

Short description of what the feature does.

string

nullable

preview

required

Whether this feature is currently in preview and may change.

boolean

min_version

required

Minimum cluster version required to use this feature.

string

>= 1 characters <= 20 characters /^[0-9]+\.[0-9]+(\.[0-9]+)?$/

max_version

required

Maximum cluster version this feature is available on.

string

>= 1 characters <= 20 characters /^[0-9]+\.[0-9]+(\.[0-9]+)?$/

Example

[
  {
    "min_version": "26.5.5",
    "max_version": "26.5.5"
  }
]

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"
}

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

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

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

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"
}