Skip to content

Delete a site

DELETE
/teams/{teamId}/domains/{domainId}
curl --request DELETE \
--url https://qinto-api.blotout.io/teams/7b8d1a52-6c1e-4b6f-9a30-2f8a54d1c3e9/domains/3f2a9c81-5d47-4e0b-8c66-91b2a7f04d15 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "confirmation": "shop.example.com" }'

Deletes a site. It leaves the team at once and stops serving once the change reaches it.

How it works

The site leaves the team as soon as the call succeeds, but it keeps serving until the change reaches it. edgeSettled reports whether that has happened: false means it is still serving and it retries on its own, so no action is needed — but do not read the response as proof it has stopped. Its resources are kept for 14 days and torn down after that. The site’s hostname stays reserved permanently, so it cannot be re-created at the same address. To guard against deleting the wrong site, confirmation must equal the site’s hostname, compared without regard to case or surrounding spaces.

Required permissions

  • domain:delete on all domains, or on the addressed domain when its id is in the route
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.

domainId
required

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

string format: uuid

Example

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

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

Confirmation that the right site is being deleted.

Media typeapplication/json

Confirmation that the right site is being deleted.

object
confirmation
required

The site’s hostname, typed back to confirm the deletion. Compared without regard to case or surrounding spaces.

string
>= 1 characters

Example

shop.example.com

The site was deleted.

Media typeapplication/json
object
deleted
required

Always true: the site has left the team.

boolean
edgeSettled
required

Whether the site’s worker already knows it is deleted. False means it is still being told; no action is needed.

boolean

Example

{
"deleted": true,
"edgeSettled": true
}

invalid_params — A path parameter failed validation (for example a malformed UUID); details pinpoints the offending parameter. invalid_body — The JSON body is unparseable or failed schema validation; details pinpoints the offending fields when the body could be parsed.

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

storage_linked — The site is part of a storage link configuration, or its unlink has not reached every worker yet, so deleting it would leave another site bound to storage that no longer exists. Remove it from the configuration and wait for the sync to settle, then 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: storage_linked

Example

{
"error": "storage_linked"
}

invalid_confirmation — The typed confirmation did not match the site’s hostname, so nothing was deleted.

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_confirmation
message

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

string

Example

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

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