ZITADEL Docs
APIsCore ResourcesV2Instance

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": "2023-01-15T01:30:15.01Z"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Was this page helpful?

Add Trusted Domain

Add Trusted Domain: Adds a Trusted Domain to 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...

Get Instance

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