hosting
POST /v1/sites/{siteId}/website-backups
Take a standard backup of a site's files and databases.
Authentication
Send an API key as a bearer token. The key must carry the hosting.backup.manage permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/website-backups \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Asks the hosting platform to build a fresh archive of this site's files and databases. `202`, because the platform runs the job afterwards and a `200` would claim an instant we never observed. ⛔ **The response is the new state of the surface, never a bare acknowledgement** — the client writes it straight into its cache, so an empty body would leave the button un-flipped and the poll never started. There is deliberately **no restore verb** on this resource: the platform restores this product from an archive the customer uploads by hand, so a Restore control here could only ever fail. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `hosting.backup.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
available | boolean | Yes | Whether this site runs on a hosting package with a standard-backup surface at all. `false` renders nothing rather than an empty list. |
retention_hours | integer | Yes | How long the platform keeps one. Sent rather than hardcoded in the client so the screen can show a real expiry, and so it cannot drift if the platform changes it. |
backup | WebsiteBackup | Yes | The current backup, or `null` when the platform holds none. ⛔ `null` never means we failed to ask — that is an error status, not an empty surface. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503