ZITADEL Docs
APIsCore ResourcesV2Instance

Get Instance

Returns the instance in the current context or by its ID. By default the instance will be determined by the context of the request, e.g. the host header. You can optionally pass an InstanceID to retrieve a specific instance. This requires additional permissions.

Required permissions:

  • iam.read
  • system.instance.read (if InstanceID is set)
POST
/zitadel.instance.v2.InstanceService/GetInstance

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

instanceId?string

InstanceID is the unique ID of the instance to be retrieved. If not set, the instance in the current context (e.g. identified by the host header) will be returned. If an ID is set, the caller must have additional permissions.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.instance.v2.InstanceService/GetInstance" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "instance": {
    "id": "string",
    "changeDate": "2023-01-15T01:30:15.01Z",
    "creationDate": "2023-01-15T01:30:15.01Z",
    "state": "STATE_UNSPECIFIED",
    "name": "string",
    "version": "string",
    "customDomains": [
      {
        "instanceId": "string",
        "creationDate": "2023-01-15T01:30:15.01Z",
        "domain": "string",
        "primary": true,
        "generated": true
      }
    ]
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Delete Instance

Delete Instance: Deletes an instance with the given ID. This method requires system level permissions and cannot be called from an instance context. Required permissions:

List Custom Domains

List Custom Domains: Lists Custom Domains of the instance. By default the instance will be determined by the context of the request, e.g. the host header. You can optionally pass an InstanceID to list the domains of a ...