ListCustomDomains

List Custom Domains

Lists Custom 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 specific instance. This requires additional permissions.

Required permissions:

iam.read
system.instance.read (if InstanceID is set)

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 whose domains will be listed. If not set, the instance in the current context (e.g. identified by the host header) will be used. If an ID is set, the caller must have additional permissions.

pagination?

Paginate and sort the results using a limit, offset and sorting.

sortingColumn?string

The field the result is sorted by.

Value in

"DOMAIN_FIELD_NAME_UNSPECIFIED" | "DOMAIN_FIELD_NAME_DOMAIN" | "DOMAIN_FIELD_NAME_PRIMARY" | "DOMAIN_FIELD_NAME_GENERATED" | "DOMAIN_FIELD_NAME_CREATION_DATE"

filters?

Filter the domains to be returned.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/zitadel.instance.v2.InstanceService/ListCustomDomains" \
  -H "Connect-Protocol-Version: 1" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://loading/zitadel.instance.v2.InstanceService/ListCustomDomains" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'

{
  "domains": [
    {
      "instanceId": "string",
      "creationDate": "1s",
      "domain": "string",
      "primary": true,
      "generated": true
    }
  ],
  "pagination": {
    "totalResult": 0,
    "appliedLimit": 0
  }
}

{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

ListCustomDomains

Header Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`