ZITADEL Docs
APIsCore ResourcesV2Instance

Update Instance

Updates instance's name 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 update a specific instance. This requires additional permissions.

Required permissions:

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

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 updated. If not set, the instance in the current context (e.g. identified by the host header) will be changed. If an ID is set, the caller must have additional permissions.

instanceName*string

InstanceName is the new name of the instance to be set.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.instance.v2.InstanceService/UpdateInstance" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "instanceName": "string"  }'
{
  "changeDate": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Remove Trusted Domain

Remove Trusted Domain: Removes a Trusted Domain from 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...

Project API

Explore the Project API operation in the ZITADEL API. Learn about request parameters, response schemas, and integration details for this endpoint.