Skip to content

Disconnect a domain

Try it

Disconnects a domain: the site stops answering on it at once (it keeps its free address). If it was the main address, the next one takes over.

DELETE/api/v1/sites/{site_id}/domains/{domain_id}

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the domains:write scope — connect, check and remove domains.

domains:writeChanges the live siteIdempotency-Key optionalMCP tool: remove_domain

Parameters

Named placeholders go in the path; the rest in the query string.

site_idstringPath · required
The site's id.1 to 100 characters
domain_idstringPath · required
The domain's id.1 to 100 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl
curl -X DELETE 'https://websites.workflowcorp.com/api/v1/sites/SITE_ID/domains/DOMAIN_ID' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"
Example arguments
{
  "site_id": "SITE_ID",
  "domain_id": "DOMAIN_ID"
}
Response schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "id",
    "deleted"
  ],
  "additionalProperties": false
}