ZITADEL Docs
APIsCore ResourcesV2Instance

DeleteInstance

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:

  • system.instance.delete
POST
/zitadel.instance.v2.InstanceService/DeleteInstance

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 deleted.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/zitadel.instance.v2.InstanceService/DeleteInstance" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "instanceId": "string"  }'
{
  "deletionDate": "1s"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?