Domain Routes

Create a domain route

Binds a verified domain to a realm. Traffic to the domain is then handled by the specified realm. The domain must be verified before creating a route. Each realm can only be bound to one domain.

Required scope: domains:write

post/clusters/{cluster_id}/domains/{domain_id}/routes

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/domains/{domain_id}/routes
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required
domain_idstring uuid required

Headers

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

Request body

realmstring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

hide_realm_pathboolean

When true, the /realms/{name} path segment is omitted from URLs. Defaults to false.

allow_admin_accessboolean

When true, the Keycloak admin console is accessible via this domain. Defaults to true.

cors_allowed_originsstring[]

CORS origins allowed to make requests via this domain.

Example request

{
  "realm": "customer-portal"
}

Response

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

idstring uuid required
domain_idstring uuid required
cluster_idstring uuid required
realmstring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

hide_realm_pathboolean required

When true, the /realms/{name} path segment is omitted from URLs served by this domain.

allow_admin_accessboolean required

When true, the Keycloak admin console is accessible via this domain.

cors_allowed_originsstring[] required

CORS origins allowed to make requests via this domain.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "realm": "customer-portal"
}

Changes

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