UpdateInstance
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.writesystem.instance.write(if InstanceID is set)
Header Parameters
Connect-Protocol-Version*number
Define the version of the Connect protocol
Value in
1Connect-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": "1s"
}{
"code": "not_found",
"message": "string",
"detail": {
"type": "string",
"value": "string",
"debug": {}
}
}Was this page helpful?