Herald
OpenapiRealms

Update custom-domain configuration (writes the host→realm mapping).

PUT
/api/realms/{realmId}/config/custom-domain

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Path Parameters

realmId*string

Realm ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

hostname?|

Precise custom login hostname (e.g. login.acme.com). null/empty clears the configured hostname.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/realms/string/config/custom-domain" \  -H "Content-Type: application/json" \  -d '{}'
{  "message": "string",  "status": null}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}