Skip to main content

Returns a list of ZITADEL instances​

Returns a list of ZITADEL instances

Request Body required

Search query for lists

    query object required

    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

    Possible values: [FIELD_NAME_UNSPECIFIED, FIELD_NAME_ID, FIELD_NAME_NAME, FIELD_NAME_CREATION_DATE]

    Default value: FIELD_NAME_UNSPECIFIED

    queries object[]
  • Array [
    • idQuery object
    ids string[]

    4820840938402429

    domainQuery object
    domains string[]

    Possible values: <= 20

    Return the instances that have the requested 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: [FIELD_NAME_UNSPECIFIED, FIELD_NAME_ID, FIELD_NAME_NAME, FIELD_NAME_CREATION_DATE]

    Default value: FIELD_NAME_UNSPECIFIED

    result object[]
  • Array [
    • id string
    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
    state string

    Possible values: [STATE_UNSPECIFIED, STATE_CREATING, STATE_RUNNING, STATE_STOPPING, STATE_STOPPED]

    Default value: STATE_UNSPECIFIED

    current state of the instance

    name string
    version string
    domains 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...