Skip to main content

Returns the custom domains of an instance Checks if a domain exists Deprecated: Use the Admin APIs ListInstanceDomains on the admin API instead

POST 
https://$CUSTOM-DOMAIN/system/v1/instances/:instanceId/domains/_search

Returns the custom domains of an instance Checks if a domain exists Deprecated: Use the Admin APIs ListInstanceDomains on the admin API instead

Request​

Path Parameters

    instanceId stringrequired

    list limitations and ordering

Body

required

    query

    object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

    sortingColumn the field the result is sorted (string)

    Possible values: [DOMAIN_FIELD_NAME_UNSPECIFIED, DOMAIN_FIELD_NAME_DOMAIN, DOMAIN_FIELD_NAME_PRIMARY, DOMAIN_FIELD_NAME_GENERATED, DOMAIN_FIELD_NAME_CREATION_DATE]

    Default value: DOMAIN_FIELD_NAME_UNSPECIFIED

    queries

    object[]

  • Array [

    • domainQuery

    object

    domain string

    zitadel.com

    method string

    Possible values: [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]

    Default value: TEXT_QUERY_METHOD_EQUALS

    defines which text equality method is used

    generatedQuery

    object

    generated boolean

    generated domains

    primaryQuery

    object

    primary boolean

    primary domains

  • ]

Responses​

A successful response.

Schema

    details

    object

    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    sortingColumn string

    Possible values: [DOMAIN_FIELD_NAME_UNSPECIFIED, DOMAIN_FIELD_NAME_DOMAIN, DOMAIN_FIELD_NAME_PRIMARY, DOMAIN_FIELD_NAME_GENERATED, DOMAIN_FIELD_NAME_CREATION_DATE]

    Default value: DOMAIN_FIELD_NAME_UNSPECIFIED

    result

    object[]

  • Array [

    • details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    domain string
    primary boolean
    generated boolean

  • ]

curl -L 'https://$CUSTOM-DOMAIN/system/v1/instances/:instanceId/domains/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "domainQuery": {
        "domain": "string",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "generatedQuery": {
        "generated": true
      },
      "primaryQuery": {
        "primary": true
      }
    }
  ]
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/system/v1
Parameters
— pathrequired
Body required
{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "DOMAIN_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "domainQuery": {
        "domain": "string",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "generatedQuery": {
        "generated": true
      },
      "primaryQuery": {
        "primary": true
      }
    }
  ]
}
ResponseClear

Click the Send API Request button above and see the response here!