Deleting a tenant¶
Note
The Admin API requires no token. The Admin API is typically protected at the network level.
Send the request as DELETE to the path /admin/v1/tenants/{tenant_id}.
Description¶
Permanently removes the tenant and all associated gateways, users, tokens, routing rules, and provider keys. This action cannot be undone.
Request¶
The following parameters are available:
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
tenant_id |
path | string |
yes | ID of the tenant. |
Responses¶
The endpoint answers the request with the following status codes:
| Status code | Description |
|---|---|
200 |
Operation succeeded. |