Skip to content

Delete a host

DELETE
/teams/{teamId}/hosts/{hostId}
curl --request DELETE \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/hosts/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15 \
--header 'Authorization: Bearer <token>'

Permanently disconnects the Cloudflare account from the team; the hostId becomes invalid for every other operation.

How it works

The delete is refused with in_use while other team resources still reference the host — remove those first; nothing is deleted partially. It is refused with wfp_revoke_failed when the host’s access cannot be withdrawn from its Cloudflare account, which is safe to retry. Deleting only severs the Blotout platform’s connection: the Cloudflare account itself is untouched.

Required permissions

  • team:write on the team
teamId
required

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

string format: uuid

Example

7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9

Unique id (UUID) of the team that owns the addressed resources, as shown in the team settings on the Blotout platform.

hostId
required

Unique id (UUID) of the host, as returned by the create and list operations.

string format: uuid

Example

3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15

Unique id (UUID) of the host, as returned by the create and list operations.

The host was disconnected; its id is no longer valid.

Media typeapplication/json
object
deleted
required

Always true: the host no longer exists. Its id becomes invalid for all other operations.

boolean

Example

{
"deleted": true
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: invalid_params
details

Field-level validation errors: a tree keyed by input property, each node carrying an errors array of human-readable messages. Render it to help the caller correct the request.

object
key
additional properties

Example

{
"error": "invalid_params",
"details": {
"errors": [],
"properties": {
"teamId": {
"errors": [
"Invalid UUID"
]
}
}
}
}

unauthenticated — The Authorization: Bearer token is missing, malformed, or no longer valid. Generate a team API token or obtain a new OAuth access token.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: unauthenticated

Example

{
"error": "unauthenticated"
}

forbidden — The bearer credential lacks the required permission or belongs to another team, or its user lacks the organization role a developer operation needs. Update its policies, use a credential bound to the addressed team, or ask an organization owner for the role; message states the reason when one is known.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: forbidden
message

Human-readable reason for this specific failure, intended for display — do not parse it programmatically.

string

Example

{
"error": "forbidden",
"message": "The Cloudflare API token is invalid or expired."
}

not_found — The addressed resource does not exist within this team; check the id and retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: not_found

Example

{
"error": "not_found"
}

in_use — The resource is still referenced by other resources and cannot be deleted; remove the dependents first. wfp_revoke_failed — The host’s WFP control token could not be revoked from its account’s dispatcher, so the operation was refused; retry once Cloudflare is reachable. wfp_route_cleanup_failed — The dispatcher route on the host’s Cloudflare zone could not be removed, so the operation was refused rather than leave the zone routing all of its traffic to Qinto; retry once Cloudflare is reachable. wfp_registry_restore_failed — The operation was refused, but the host’s control token had already been withdrawn from its account’s dispatcher and could not be put back, so that dispatcher cannot register new sites until the host is synced.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: in_use wfp_revoke_failed wfp_route_cleanup_failed wfp_registry_restore_failed

Example

{
"error": "in_use"
}

internal — Unexpected server error. Nothing is guaranteed to have been persisted; idempotent operations are safe to retry.

Media typeapplication/json
object
error
required

Machine-readable error slug; switch on this value rather than on the HTTP status alone.

string
Allowed values: internal

Example

{
"error": "internal"
}