Skip to main content

List Instance Domains​

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

Query Parameters
  • query.offset uint64
  • query.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.

  • query.asc boolean

    default is descending

  • 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

    the field the result is sorted

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
  • domain string
  • primary boolean
  • generated boolean
  • ]
Loading...