Skip to content

API Reference

Skycloak Public API 2026-03-01

Section titled “Skycloak Public API 2026-03-01”

Programmatic management of Keycloak infrastructure on the Skycloak platform.

Information

  • License: Proprietary
  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/clusters
POST
/clusters
GET
/clusters/{cluster_id}
DELETE
/clusters/{cluster_id}
PATCH
/clusters/{cluster_id}
GET
/clusters/{cluster_id}/credentials
GET
/clusters/{cluster_id}/maintenance-window
PUT
/clusters/{cluster_id}/maintenance-window
DELETE
/clusters/{cluster_id}/maintenance-window
POST
/clusters/{cluster_id}/restart-instances
GET
/clusters/{cluster_id}/upgrade-path
GET
/clusters/{cluster_id}/upgrade-preview
GET
/clusters/{cluster_id}/upgrades
POST
/clusters/{cluster_id}/upgrades/cancel
GET
/cluster-types
GET
/cluster-types/{cluster_type}/upgrade-preview
GET
/cluster-types/{cluster_type}/versions
GET
/cluster-features
GET
/cluster-locations
GET
/clusters/{cluster_id}/realms
POST
/clusters/{cluster_id}/realms
GET
/clusters/{cluster_id}/realms/{realm_name}
DELETE
/clusters/{cluster_id}/realms/{realm_name}
PATCH
/clusters/{cluster_id}/realms/{realm_name}
GET
/clusters/{cluster_id}/realms/{realm_name}/users
POST
/clusters/{cluster_id}/realms/{realm_name}/users
GET
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}
DELETE
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}
PATCH
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}
GET
/clusters/{cluster_id}/realms/{realm_name}/roles
POST
/clusters/{cluster_id}/realms/{realm_name}/roles
GET
/clusters/{cluster_id}/realms/{realm_name}/roles/{role_name}
DELETE
/clusters/{cluster_id}/realms/{realm_name}/roles/{role_name}
PATCH
/clusters/{cluster_id}/realms/{realm_name}/roles/{role_name}
GET
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}/roles
POST
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}/roles
DELETE
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}/roles/{role_name}
GET
/clusters/{cluster_id}/realms/{realm_name}/clients/{client_id}/roles
POST
/clusters/{cluster_id}/realms/{realm_name}/clients/{client_id}/roles
GET
/clusters/{cluster_id}/realms/{realm_name}/clients/{client_id}/roles/{role_name}
DELETE
/clusters/{cluster_id}/realms/{realm_name}/clients/{client_id}/roles/{role_name}
PATCH
/clusters/{cluster_id}/realms/{realm_name}/clients/{client_id}/roles/{role_name}
GET
/clusters/{cluster_id}/realms/{realm_name}/groups
POST
/clusters/{cluster_id}/realms/{realm_name}/groups
GET
/clusters/{cluster_id}/realms/{realm_name}/groups/{group_id}
DELETE
/clusters/{cluster_id}/realms/{realm_name}/groups/{group_id}
PATCH
/clusters/{cluster_id}/realms/{realm_name}/groups/{group_id}
GET
/clusters/{cluster_id}/realms/{realm_name}/groups/{group_id}/members
GET
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}/groups
PUT
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}/groups/{group_id}
DELETE
/clusters/{cluster_id}/realms/{realm_name}/users/{user_id}/groups/{group_id}
GET
/clusters/{cluster_id}/realms/{realm_name}/applications
POST
/clusters/{cluster_id}/realms/{realm_name}/applications
GET
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}
DELETE
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}
PATCH
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}
GET
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}/roles
POST
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}/roles
DELETE
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}/roles/{role_name}
POST
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}/rotate-secret
GET
/clusters/{cluster_id}/realms/{realm_name}/applications/{client_id}/sessions
GET
/clusters/{cluster_id}/realms/{realm_name}/identity-providers
POST
/clusters/{cluster_id}/realms/{realm_name}/identity-providers
GET
/clusters/{cluster_id}/realms/{realm_name}/identity-providers/{provider_id}
DELETE
/clusters/{cluster_id}/realms/{realm_name}/identity-providers/{provider_id}
PATCH
/clusters/{cluster_id}/realms/{realm_name}/identity-providers/{provider_id}
POST
/clusters/{cluster_id}/realms/{realm_name}/identity-providers/{provider_id}/test
GET
/identity-provider-templates
POST
/identity-providers/discover-oidc
GET
/clusters/{cluster_id}/logs
GET
/clusters/{cluster_id}/security-logs
GET
/clusters/{cluster_id}/insights/authentication
GET
/clusters/{cluster_id}/insights/events
GET
/clusters/{cluster_id}/insights/overview
GET
/clusters/{cluster_id}/insights/performance
GET
/clusters/{cluster_id}/insights/security
GET
/clusters/{cluster_id}/events
GET
/clusters/{cluster_id}/events/export
GET
/clusters/{cluster_id}/security
PATCH
/clusters/{cluster_id}/security
GET
/clusters/{cluster_id}/security/captcha/domains
POST
/clusters/{cluster_id}/security/captcha/domains
DELETE
/clusters/{cluster_id}/security/captcha/domains/{hostname}
GET
/clusters/{cluster_id}/domains
POST
/clusters/{cluster_id}/domains
GET
/clusters/{cluster_id}/domains/{domain_id}
DELETE
/clusters/{cluster_id}/domains/{domain_id}
POST
/clusters/{cluster_id}/domains/{domain_id}/verify
GET
/clusters/{cluster_id}/domains/{domain_id}/routes
POST
/clusters/{cluster_id}/domains/{domain_id}/routes
GET
/clusters/{cluster_id}/domains/{domain_id}/routes/{route_id}
DELETE
/clusters/{cluster_id}/domains/{domain_id}/routes/{route_id}
PATCH
/clusters/{cluster_id}/domains/{domain_id}/routes/{route_id}
GET
/clusters/{cluster_id}/realms/{realm}/smtp
PUT
/clusters/{cluster_id}/realms/{realm}/smtp
DELETE
/clusters/{cluster_id}/realms/{realm}/smtp
POST
/clusters/{cluster_id}/realms/{realm}/smtp/test
GET
/clusters/{cluster_id}/realms/{realm}/branding/login
PUT
/clusters/{cluster_id}/realms/{realm}/branding/login
DELETE
/clusters/{cluster_id}/realms/{realm}/branding/login
GET
/clusters/{cluster_id}/realms/{realm}/branding/email
PUT
/clusters/{cluster_id}/realms/{realm}/branding/email
DELETE
/clusters/{cluster_id}/realms/{realm}/branding/email
GET
/clusters/{cluster_id}/realms/{realm}/applications/{client_id}/themes
PATCH
/clusters/{cluster_id}/realms/{realm}/applications/{client_id}/themes
GET
/clusters/{cluster_id}/realms/{realm}/themes
PATCH
/clusters/{cluster_id}/realms/{realm}/themes
GET
/clusters/{cluster_id}/themes
POST
/clusters/{cluster_id}/themes
GET
/clusters/{cluster_id}/themes/{theme_id}
DELETE
/clusters/{cluster_id}/themes/{theme_id}
PATCH
/clusters/{cluster_id}/themes/{theme_id}
GET
/clusters/{cluster_id}/themes/{theme_id}/content
PUT
/clusters/{cluster_id}/themes/{theme_id}/content
GET
/theme-settings
PUT
/theme-settings
GET
/extensions
POST
/extensions
GET
/extensions/{extension_id}
DELETE
/extensions/{extension_id}
PATCH
/extensions/{extension_id}
POST
/extensions/{extension_id}/versions
GET
/clusters/{cluster_id}/extensions
POST
/clusters/{cluster_id}/extensions
DELETE
/clusters/{cluster_id}/extensions/{extension_id}
POST
/clusters/{cluster_id}/extensions/{extension_id}/upgrade
GET
/clusters/{cluster_id}/exports
POST
/clusters/{cluster_id}/exports
GET
/clusters/{cluster_id}/exports/{export_id}
DELETE
/clusters/{cluster_id}/exports/{export_id}
POST
/clusters/{cluster_id}/realms/{realm}/exports
GET
/realm-exports/{export_id}
GET
/clusters/{cluster_id}/backup-schedule
PUT
/clusters/{cluster_id}/backup-schedule
GET
/clusters/{cluster_id}/backups
POST
/clusters/{cluster_id}/backups
GET
/clusters/{cluster_id}/backups/{backup_id}
POST
/clusters/{cluster_id}/backups/{backup_id}/download-link
POST
/clusters/{cluster_id}/realms/import
POST
/clusters/{cluster_id}/realms/import/upload-url
GET
/realm-imports/{import_id}
GET
/siem/destinations
POST
/siem/destinations
GET
/siem/destinations/{destination_id}
DELETE
/siem/destinations/{destination_id}
PATCH
/siem/destinations/{destination_id}
POST
/siem/destinations/{destination_id}/test
GET
/webhook-event-types
GET
/webhooks
POST
/webhooks
GET
/webhooks/{webhook_id}
DELETE
/webhooks/{webhook_id}
PATCH
/webhooks/{webhook_id}
POST
/webhooks/{webhook_id}/test

Authentication

Section titled “Authentication”

ApiKeyAuth

Section titled “ApiKeyAuth”

Security scheme type: apiKey

Header parameter name: API-Key

© 2026 Skycloak. All Rights Reserved. Design by Yasser SolimanKeycloak™ is a trademark of the Linux Foundation. Skycloak is not affiliated with the Keycloak project.