Skip to content

Delete Tenant Endpoint

POST
/admin/force-delete-tenant
 
curl --request POST \
  --url https://example.com/admin/force-delete-tenant \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-AdminKey: <X-Tenzir-AdminKey>' \
  --data '{ "tenant_id": "example", "reason": "example" }'

Similar to the user /delete-tenant endpoint, but does not protect shared tenants from deletion.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
DeleteTenantRequest
object
tenant_id
required
Tenant Id
string
reason
Any of:
string
Example generated
{
  "tenant_id": "example",
  "reason": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
DeleteTenantResponse
object
infra_errors
required
Infra Errors
Array<string>
Example generated
{
  "infra_errors": [
    "example"
  ]
}

403

Section titled “403 ”

{"detail": "Invalid API Key"} {"detail": "Not permitted to access this tenant"}

404

Section titled “404 ”

{"detail": "Tenant not found"}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}