ZITADEL Docs
APIsCore ResourcesV2Instance

Remove Custom Domain

Removes a Custom Domain from the instance. Be aware that this will stop routing requests from this domain to the instance and might break existing setups or integrations. This method requires system level permissions and cannot be called from an instance context.

Required permissions:

  • system.domain.write
POST
/zitadel.instance.v2.InstanceService/RemoveCustomDomain

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 from which the domain will be removed.

customDomain*string

CustomDomain is the the domain to remove from the instance.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.instance.v2.InstanceService/RemoveCustomDomain" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "instanceId": "string",    "customDomain": "string"  }'
{
  "deletionDate": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

List Trusted Domains

List Trusted Domains: Lists Trusted Domains of 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...

Remove Trusted Domain

Remove Trusted Domain: Removes a Trusted Domain from 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...