Skip to content

Create a domain route

POST
/clusters/{cluster_id}/domains/{domain_id}/routes
curl --request POST \
  --url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/routes \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta' \
  --header 'Content-Type: application/json' \
  --data '{ "realm": "customer-portal", "hide_realm_path": true, "allow_admin_access": true, "cors_allowed_origins": [ "example" ] }'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
cluster_id
required
string format: uuid
domain_id
required
string format: uuid

Header Parameters

Section titled “Header Parameters”
API-Version
required
string
Allowed values: 2026-06-01.beta

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
realm
required

The realm that will handle traffic for this domain.

string
>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/
hide_realm_path

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

boolean
allow_admin_access

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

boolean
cors_allowed_origins

CORS origins allowed to make requests via this domain.

Array<string>

Responses

Section titled “Responses”

201

Section titled “201”

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

Media typeapplication/json

A route that maps a custom domain to a Keycloak realm. Traffic arriving at the domain is served by the associated realm.

object
id
required
string format: uuid
domain_id
required
string format: uuid
cluster_id
required
string format: uuid
realm
required

The realm that handles traffic for this domain.

string
>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/
hide_realm_path
required

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

boolean
allow_admin_access
required

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

boolean
cors_allowed_origins
required

CORS origins allowed to make requests via this domain.

Array<string>
created_at
required
string format: date-time
updated_at
required
string format: date-time

Example 

{
  "realm": "customer-portal"
}

400

Section titled “400”

The server could not understand the request due to invalid syntax.

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

401

Section titled “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"
}

403

Section titled “403”

Access is forbidden.

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

Section titled “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"
}

409

Section titled “409”

The request conflicts with the current state of the server.

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

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
}
© 2026 Skycloak. All Rights Reserved. Design by Yasser SolimanKeycloak™ is a trademark of the Linux Foundation. Skycloak is not affiliated with the Keycloak project.