Delete a platform tenant vanity domain.

DELETE

/api/admin/platform/tenant-vanity-domains/{id}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://auth.example.com/api/admin/platform/tenant-vanity-domains/example \
  --header 'Authorization: Bearer <token>'

Soft-delete a tenant vanity domain across tenants, clear its active and primary keys, optionally delete the Cloudflare custom hostname, and invalidate vanity-domain cache entries.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Tenant vanity domain identifier.

Responses

200

Successful operation response.

Media type application/json

object

success

required

boolean

key

additional properties

Example

{
  "success": true
}

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"
}

500

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"
}