ZITADEL Docs
APIsCore ResourcesV2Instance

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
POST
/zitadel.instance.v2.InstanceService/AddCustomDomain

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-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": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Instance API

Explore the Instance API operation in the ZITADEL API. Learn about request parameters, response schemas, and integration details for this endpoint.

Add Trusted Domain

Add Trusted Domain: Adds a Trusted Domain to the instance. By default the instance will be determined by the context of the request, e.g. the host header. You can optionally pass an InstanceID to list the domains of a...