HydraCore
API by router

Admin tenant lifecycle

Teardown Tenant Endpoint

POST
/internal/v1/admin/tenants/{tenant_id}/teardown

Path Parameters

tenant_id*Tenant Id
Formatuuid

Header Parameters

authorization?string|null

Request Body

application/json
  1. body

Request body for tenant teardown.

extra='forbid' so callers can't sneak tenant_id / actor_user_id / etc. into the body — those come from the URL + the auth dep

  • request.client. The only thing the body carries is the confirmation phrase.
confirmation_phrase*Confirmation Phrase

Literal DELETE TENANT <tenant_slug> where <tenant_slug> is the target tenant's actual slug. Mismatch returns 400.

Length1 <= length <= 200

Response Body

Successful Response

application/json
  1. response

Summary returned to the caller after a successful teardown.

actor_kind*Actor Kind
deleted_at*Deleted At
instances_terminated*Instances Terminated
rows_per_table*
tenant_id*Tenant Id
tenant_name*Tenant Name
tenant_slug*Tenant Slug
warnings*array<string>
Example Request
curl -X POST 'https://example.com/internal/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/teardown' \  -H 'Content-Type: application/json' \  -d '{  "confirmation_phrase": "string"}'
Example Response
{  "actor_kind": "string",  "deleted_at": "string",  "instances_terminated": 0,  "rows_per_table": {    "property1": 0,    "property2": 0  },  "tenant_id": "string",  "tenant_name": "string",  "tenant_slug": "string",  "warnings": [    "string"  ]}