Delete tenant API Reference

DELETE

/tenants/{tenant}

curl --request DELETE \
  --url https://api.kupe.cloud/api/v1/tenants/acme \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "cascade": false, "confirm": "acme" }'

Request deletion of the tenant. Only the tenant owner (the contactEmail on the tenant) may call this, and only with an OIDC bearer token. API keys are refused (403, code owner_required), as are other admins.

Authorizations

• BearerAuth

Parameters

Path Parameters

tenant

required

string

Tenant name

Request Body

Confirmation (and optional cascade)

Media type application/json

object

cascade

Delete every cluster in the tenant first. Without it the request is refused (409 clusters_exist) while any cluster is not already terminating. Clusters are deleted one at a time, and deletion stops at the first cluster an app environment still uses (409 cluster_in_use), so some clusters may already be deleted. Delete apps first, and wait until they are gone. Never deletes databases or the registry: those always refuse the request (409 databases_exist, registries_exist) until deleted on their own.

boolean

Example

false

confirm

Must equal the tenant name in the path; guards against accidental deletion.

string

Example

acme

Responses

202

Deletion accepted; tenant is Terminating

Media type application/json

object

name

string

status

object

phase

Always “Terminating” on acceptance; GET /tenants/{tenant} reports the same phase until the tenant is gone (then 404).

string

Example

{
  "name": "acme",
  "status": {
    "phase": "Terminating"
  }
}

400

Confirm does not match the tenant name (code confirm_mismatch) or invalid body

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

401

Missing or invalid authentication

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

403

API key or non-owner caller (code owner_required); not a member of this tenant

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

404

Tenant not found (already gone)

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

409

Active apps (code apps_exist), active databases (code databases_exist), a registry (code registries_exist), active clusters without cascade (code clusters_exist), a cluster an app environment still uses (code cluster_in_use) or already terminating (code already_terminating)

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}

429

Rate limit exceeded (one deletion request per minute per caller; see Retry-After)

Media type application/json

object

code

string

error

string

field

string

message

string

severity

string

Example ^generated

{
  "code": "example",
  "error": "example",
  "field": "example",
  "message": "example",
  "severity": "example"
}