hosting
GET /v1/sites/{siteId}/website-backups
The standard backup a site's hosting package currently holds.
Authentication
Send an API key as a bearer token. The key must carry the sites.view 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 GET 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
The hosting platform's **included** on-demand backup for this site — a downloadable archive of files and databases. This is a different product from `getSiteVendorSnapshots`, which is the platform's *paid* point-in-time service, and from `listSiteBackups`, which is our own archive. ⛔ **The platform deletes one of these after `retention_hours`** (12 today). That is the character of the product: it is a button, not a history, and a client must render the real age rather than presenting it as durable protection. `backup` is `null` when the platform holds none — never when we failed to ask, which is an error status. ⭐ `complete` is not `status` restated: it also requires a `download_url`, because a job reporting completion with no archive is nothing the customer can act on. `404` for a site with no vendor hosting package, or one that is not the caller's. Requires `sites.view`.
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