List clusters

GET

/clusters

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

• Local development

Returns all clusters in the workspace.

Required scope: clusters:read

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>

A summary of a Keycloak cluster, used in list responses.

object

id

required

Unique cluster identifier.

string format: uuid

name

required

Human-readable cluster name.

string

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

type

required

string

Allowed values: keycloak tidecloak

size

required

string

Allowed values: small medium large

version

required

Cluster version in semver format. Check the documentation for the latest supported versions.

string

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

location

required

Region where the cluster is hosted.

string

Allowed values: us us-west ca au eu

status

required

string

Allowed values: provisioning available updating degraded maintenance stopped failed deleting

management_mode

required

Skycloak manages the full lifecycle of the cluster. Every cluster is fully managed.

string

Allowed values: full

url

required

Keycloak instance URL. Only non-empty once the cluster reaches available status.

string format: uri

sso_enabled

required

Whether admin console SSO integration is enabled for this cluster.

boolean

auto_upgrade_enabled

Whether automatic patch upgrades are enabled for this cluster.

boolean

http_relative_path

required

Path prefix Keycloak is served from (e.g. /auth). Empty string means /.

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

[
  {
    "type": "keycloak",
    "size": "small",
    "version": "26.5.5",
    "location": "us",
    "status": "provisioning",
    "management_mode": "full",
    "http_relative_path": ""
  }
]

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