Returns a list of ZITADEL instances

Returns a list of ZITADEL instances

application/json

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

  ]

application/grpc

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

  ]

application/grpc-web+proto

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

  ]

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

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

  ]

  ]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2023-05-10"
  },
  "sortingColumn": "FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2023-05-10",
        "changeDate": "2023-05-10",
        "resourceOwner": "69629023906488334"
      },
      "state": "STATE_UNSPECIFIED",
      "name": "ZITADEL",
      "version": "1.0.0",
      "domains": [
        {
          "details": {
            "sequence": "2",
            "creationDate": "2023-05-10",
            "changeDate": "2023-05-10",
            "resourceOwner": "69629023906488334"
          },
          "domain": "zitadel.com",
          "primary": true,
          "generated": true
        }
      ]
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

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

  ]

  ]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2023-05-10"
  },
  "sortingColumn": "FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2023-05-10",
        "changeDate": "2023-05-10",
        "resourceOwner": "69629023906488334"
      },
      "state": "STATE_UNSPECIFIED",
      "name": "ZITADEL",
      "version": "1.0.0",
      "domains": [
        {
          "details": {
            "sequence": "2",
            "creationDate": "2023-05-10",
            "changeDate": "2023-05-10",
            "resourceOwner": "69629023906488334"
          },
          "domain": "zitadel.com",
          "primary": true,
          "generated": true
        }
      ]
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

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

  ]

  ]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2023-05-10"
  },
  "sortingColumn": "FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "69629023906488334",
      "details": {
        "sequence": "2",
        "creationDate": "2023-05-10",
        "changeDate": "2023-05-10",
        "resourceOwner": "69629023906488334"
      },
      "state": "STATE_UNSPECIFIED",
      "name": "ZITADEL",
      "version": "1.0.0",
      "domains": [
        {
          "details": {
            "sequence": "2",
            "creationDate": "2023-05-10",
            "changeDate": "2023-05-10",
            "resourceOwner": "69629023906488334"
          },
          "domain": "zitadel.com",
          "primary": true,
          "generated": true
        }
      ]
    }
  ]
}

Returned when the user does not have permission to access the resource.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...