Delete a site

DELETE

/v1/sites/{id}

const url = 'https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.overwatch.weareheavy.dev/v1/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'x-api-key: <x-api-key>'

Delete a site. Stops any in-flight crawl, removes the site, and cascades its runs and broken links away. The usage ledger survives — a deleted site still appears in usage/billing under its hostname. Frees a slot against the organization’s site quota.

Requires an owner/admin session or an API key with access to the site.

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Path Parameters

required

string format: uuid

The site’s UUID.

Responses

200

The site was deleted.

application/json

object

deleted

required

boolean

Example

{
  "deleted": true
}

401

Missing or invalid credentials.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "invalid api key"
}

403

The caller’s role or key scope does not allow this action.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "only owners and admins can edit site settings"
}

404

No site with that id is visible to the caller.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "site not found"
}