ZITADEL Docs
APIsCore ResourcesV1Instance Lifecycle

ListInstances

Returns a list of Zitadel instances

Deprecated: Use ListInstances instead to list instances

POST
/instances/_search

Request Body

application/json

query?

list limitations and ordering

sortingColumn?string

the field the result is sorted

Value in"FIELD_NAME_UNSPECIFIED" | "FIELD_NAME_ID" | "FIELD_NAME_NAME" | "FIELD_NAME_CREATION_DATE"
queries?

criterias the client is looking for

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/instances/_search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "1s"
  },
  "sortingColumn": "FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "string",
      "details": {
        "sequence": 0,
        "creationDate": "1s",
        "changeDate": "1s",
        "resourceOwner": "string"
      },
      "state": "STATE_UNSPECIFIED",
      "name": "string",
      "version": "string",
      "domains": [
        {
          "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?