API Reference

The interactive reference below is generated from the Skycloak Public API’s OpenAPI specification. Every endpoint lists its parameters, request and response schemas, and example payloads, and you can send live requests straight from the page once you supply an API key.

Before you start, three things are worth knowing:

• Authentication. Every request to this API authenticates with an API key in the API-Key header. Keys carry explicit scopes such as clusters:write, so grant only what a given integration needs. Note that the OAuth 2.0 client-credentials grant is a different credential entirely: it belongs to your cluster’s own Keycloak, not to this API. See Authentication.
• Versioning. The API is in beta and every request must send the version header. See Versioning for the current value and the support policy.
• Rate limits. Requests are throttled per workspace, and the response headers tell you where you stand. See Rate limiting.

If this is your first call, Getting started walks through creating a key and making a request end to end. When something comes back that you did not expect, Errors lists the status codes and error shapes the API returns.