Skip to main content

GetInstance

POST 

/zitadel.instance.v2.InstanceService/GetInstance

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)

Request​

Responses​

Success

Was this page useful?