ZITADEL Docs
APIsCore ResourcesV1Instance Lifecycle

List Domains

Deprecated: use instance service v2 ListCustomDomains instead.

Returns the Custom Domains of an instance.

POST
/instances/{instance_id}/domains/_search

Path Parameters

instance_id*string

list limitations and ordering

Request Body

application/json

query?
sortingColumn?string

the field the result is sorted

Value in"DOMAIN_FIELD_NAME_UNSPECIFIED" | "DOMAIN_FIELD_NAME_DOMAIN" | "DOMAIN_FIELD_NAME_PRIMARY" | "DOMAIN_FIELD_NAME_GENERATED" | "DOMAIN_FIELD_NAME_CREATION_DATE"
queries?array<||>

criterias the client is looking for

[key: string]?never

Response Body

application/json

curl -X POST "https://loading/instances/string/domains/_search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "2023-01-15T01:30:15.01Z"
  },
  "sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "details": {
        "sequence": 0,
        "creationDate": "2023-01-15T01:30:15.01Z",
        "changeDate": "2023-01-15T01:30:15.01Z",
        "resourceOwner": "string"
      },
      "domain": "string",
      "primary": true,
      "generated": true
    }
  ]
}

Was this page helpful?

Healthz

Healthz: Indicates if Zitadel is running. It respondes as soon as Zitadel started

ListFailedEvents

ListFailedEvents: Returns event descriptions which cannot be processed. It's possible that some events need some retries. For example if the SMTP-API wasn't able to send an email at the first time