Get versions for a cluster type

GET

/cluster-types/{cluster_type}/versions

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

• Local development

Returns the list of available versions for the given cluster type.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

cluster_type

required

string

Allowed values: keycloak tidecloak

Header Parameters

API-Version

required

string

Allowed values: 2026-06-01.beta

Responses

200

The request has succeeded.

Media typeapplication/json

Array<object>

A supported version of a cluster type, with the detail needed to judge the upgrade step onto it.

object

version

required

The version number.

string

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

active

required

Whether the version is currently offered for new clusters and upgrades. false means it is still recognised, for example by a cluster already running it, but is no longer offered.

boolean

is_major_change

required

Whether moving onto this version from the previous supported version crosses a major version boundary.

boolean

breaking_change_count

required

Number of breaking changes recorded for this version.

integer format: int32

Example

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

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

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

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