ZITADEL Docs
APIsCore ResourcesV1Instance Objects

ListInstanceDomains

List Instance Domains

Deprecated: use instance service v2 GetInstance instead.

Returns a list of domains that are configured for this Zitadel instance. These domains are the URLs where Zitadel is running.

POST
/domains/_search

Query Parameters

query.offset?integer|string
Formatint64
query.limit?integer
query.asc?boolean
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.domainQuery.domain?string
queries.domainQuery.method?string
Value in"TEXT_QUERY_METHOD_EQUALS" | "TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE" | "TEXT_QUERY_METHOD_STARTS_WITH" | "TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE" | "TEXT_QUERY_METHOD_CONTAINS" | "TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE" | "TEXT_QUERY_METHOD_ENDS_WITH" | "TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE"
queries.generatedQuery.generated?boolean
queries.primaryQuery.primary?boolean

Response Body

application/json

application/json

curl -X POST "https://loading/domains/_search"
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "1s"
  },
  "sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "details": {
        "sequence": 0,
        "creationDate": "1s",
        "changeDate": "1s",
        "resourceOwner": "string"
      },
      "domain": "string",
      "primary": true,
      "generated": true
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?