Sites

Delete a site

Takes the site offline right away and removes it from the list. Its files and versions are kept for 30 days: POST /sites/{id}/restore puts it back, and GET /sites/deleted lists what can still be restored. After 30 days everything is erased for good. With permanent=true everything is erased right away and the site cannot be restored, also for a site that was already deleted; use it only when the owner explicitly asks for that. The slug stays taken, so an old link never shows someone else's site. Deleting it again returns 204 as well. A site Hypamoon took offline (taken_offline) cannot be deleted: 403 site_offline.

delete/sites/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/sites/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:write)

Path parameters

idstring uuid required

The id of the site.

Query parameters

permanentboolean

true erases the site and its files right away, without the 30 days to restore it. Only when the owner explicitly asks for it.

Response

Four-eyes approval is on: the deletion waits for another owner or builder. Nothing has changed on the live site yet.

object'deploy_approval' required
idstring uuid required

The id of the request; pass it as approval_id to approve_deploy or reject_deploy.

status'pending' | 'processing' | 'approved' | 'rejected' | 'failed' | 'superseded' | 'expired' required

pending until another owner or builder decides. superseded: a newer deploy of the same site replaced it. expired: after 7 days.

kind'new_site' | 'site_update' | 'site_delete' | 'app_deploy' | 'app_rollback' required

app_deploy and app_rollback: server code of an app (deploy_app, rollback_app); files and bytes are its modules.

site_idstring uuid nullable required
namestring nullable required
slugstring nullable required
urlstring nullable required

The address of the site. For an update or deletion it still shows the live version until approval.

filesinteger required
bytesinteger required
password_change'none' | 'remove' | 'set' required
requested_atstring required
expires_atstring required
reviewed_bystring uuid nullable required
reviewed_atstring nullable required
reasonstring nullable required
resultobject nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.