API
Versioning

Versioning

Beta Status

⚠️
The Skycloak API is currently in beta. While we aim for stability, breaking changes may occur without prior notice during this period.

Required Version Header

Skycloak uses date-based API versions. Pin your integration to the current beta version by sending the API-Version request header on every public API request:

curl https://api.skycloak.io/clusters \
  -H "API-Key: $SKYCLOAK_API_KEY" \
  -H "API-Version: 2026-06-01.beta"

Requests without the header, or with an unsupported version, are rejected.

Version Support

  • Beta versions use the .beta suffix and may include breaking changes.
  • General availability versions will use date-based version identifiers without the beta suffix.
  • Breaking changes will be introduced in new versions.
  • Supported versions and deprecation windows will be announced before general availability.

Breaking Changes During Beta

Changes that alter an existing response shape on the current beta version are recorded here.

GET /cluster-types/{cluster_type}/versions returns objects

The response was a list of version strings (["26.2.4", "27.0.0"]) and is now a list of objects, each with version, active, is_major_change and breaking_change_count. Read version from each entry. The richer shape is what lets a caller tell a clean patch step from a major or a release with breaking changes. See Cluster versions and upgrades.

Last updated on
Rate LimitingAPI Reference