Skip to content

Delete a site

DELETE
/sites/{name}
curl --request DELETE \
--url https://example.com/sites/example \
--header 'Authorization: Bearer <token>'
name
required
Name
string

Successful Response

Authentication is required.

Media typeapplication/json
ErrorResponse
object
detail
required
Detail
string
Examplegenerated
{
"detail": "example"
}

A session token and site ownership are required.

Media typeapplication/json
ErrorResponse
object
detail
required
Detail
string
Examplegenerated
{
"detail": "example"
}

The site does not exist.

Media typeapplication/json
ErrorResponse
object
detail
required
Detail
string
Examplegenerated
{
"detail": "example"
}

Every custom domain must complete removal before deleting the site.

Media typeapplication/json
ErrorResponse
object
detail
required
Detail
string
Examplegenerated
{
"detail": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}