Clean up failed tenant provisioning

POST

/api/admin/tenants/{id}/provisioning/cleanup

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tenants/example/provisioning/cleanup \
  --header 'Authorization: Bearer <token>'

Cancels a pre-activation Control provisioning operation, removes the failed tenant draft, and releases any uncommitted route allocation. Cleanup is rejected after Lookup activation may have become externally visible.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Tenant provisioning cleanup response.

Media type application/json

object

status

required

string

Allowed values: cleaned

tenant_id

required

string

operation_id

required

string

key

additional properties

Example

{
  "status": "cleaned",
  "tenant_id": "acme",
  "operation_id": "tenant_create_018f3f7c85b07c5da6b61c3a6e6b9e01"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}