ZITADEL Docs
APIsCore ResourcesV1Instance Lifecycle

GetInstance

Returns the detail of an instance

Deprecated: Use GetInstance instead to get the details of the instance in context

GET
/instances/{instance_id}

Path Parameters

instance_id*string

Response Body

application/json

application/json

curl -X GET "https://loading/instances/string"
{
  "instance": {
    "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?