Get a domain route
GET
/clusters/{cluster_id}/domains/{domain_id}/routes/{route_id}
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/routes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
method: 'GET',
headers: {'API-Version': '2026-06-01.beta', 'API-Key': '<API-Key>'}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request GET \
--url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/routes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta'Required scope: domains:read
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
route_id
required
string format: uuid
Header Parameters
Section titled “Header Parameters”API-Version
required
string
Responses
Section titled “Responses”The request has succeeded.
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
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"
}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"
}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"
}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"
}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
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"
}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"
}