AddCustomDomain
Add Custom Domain
Adds a Custom Domain to the instance. The Custom Domain must be unique across all instances. Once the domain is added, it will be used to route requests to this instance. This method requires system level permissions and cannot be called from an instance context.
Required permissions:
system.domain.write
Header Parameters
Connect-Protocol-Version*number
Define the version of the Connect protocol
Value in
1Connect-Timeout-Ms?number
Define the timeout, in ms
Request Body
application/json
instanceId*string
InstanceID is the unique ID of the instance to which the domain will be added.
customDomain*string
Custom Domain to add to the instance. Must be a valid domain name. Once the domain is added, it will be used to route requests to this instance.
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://loading/zitadel.instance.v2.InstanceService/AddCustomDomain" \ -H "Connect-Protocol-Version: 1" \ -H "Content-Type: application/json" \ -d '{ "instanceId": "string", "customDomain": "string" }'{
"creationDate": "1s"
}{
"code": "not_found",
"message": "string",
"detail": {
"type": "string",
"value": "string",
"debug": {}
}
}Was this page helpful?