Clusters

Create a cluster

Required scope: clusters:write

post/clusters

Request

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

Headers

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

Request body

namestring required
type'keycloak' | 'tidecloak'
size'small' | 'medium' | 'large' required
versionstring required

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

location'us' | 'us-west' | 'ca' | 'au' | 'eu' required

Region where the cluster is hosted.

management_mode'full'

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

featuresstring[]

Keycloak feature flags to enable on the cluster at creation time.

features_disabledstring[]

Keycloak feature flags to disable on the cluster at creation time.

http_relative_pathstring

HTTP path prefix to serve Keycloak from (e.g. /auth). Defaults to /.

auto_upgrade_enabledboolean

Enable automatic patch upgrades. Requires a maintenance window; one is provisioned if not supplied.

Example request

{
  "name": "my-cluster",
  "size": "small",
  "version": "26.5.5",
  "location": "us"
}

Response

The request has succeeded and a new resource has been created as a result.

idstring uuid required
namestring required
type'keycloak' | 'tidecloak' required
size'small' | 'medium' | 'large' required
versionstring required

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

location'us' | 'us-west' | 'ca' | 'au' | 'eu' required

Region where the cluster is hosted.

status'provisioning' | 'available' | 'updating' | 'degraded' | 'maintenance' | 'stopped' | 'failed' | 'deleting' required
management_mode'full' required

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

urlstring uri required

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

sso_enabledboolean required

Whether admin console SSO integration is enabled for this cluster.

auto_upgrade_enabledboolean

Whether automatic patch upgrades are enabled for this cluster.

http_relative_pathstring required

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

created_atstring date-time required
updated_atstring date-time required
featuresstring[] required

Keycloak feature flags explicitly enabled on this cluster.

features_disabledstring[] required

Keycloak feature flags explicitly disabled on this cluster.

Example response

{
  "version": "26.5.5"
}

Changes

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