hosting
GET /v1/sites/{siteId}/hourly-backups
Read a site's hourly backups add-on.
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}/hourly-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
Whether the paid hourly-backups add-on (hourly_backups, L40 B02) is on sale for this site, whether it is on, its price in the caller's currency, when it renews (or the last day it runs once stopped), how long each hourly restore point is kept (keep_hours, 48) and when the newest hourly backup was taken. refusal is the reason it cannot be bought right now (already on, a site hosted elsewhere, not on sale yet), or null. Buy it through purchaseExtra (POST /v1/extras/hourly_backups/purchase with site_id); the backups themselves are listed by getSiteBackups with trigger hourly. Every site keeps its nightly backup; hourly points are on top. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
offered | boolean | Yes | Whether hourly backups are on sale to this organisation. |
active | boolean | Yes | Whether hourly backups are running for this site now. |
can_buy | boolean | Yes | Whether this site may buy hourly backups right now. |
refusal | string | Yes | Why it cannot be bought right now, or null. |
price | MoneyAmount | Yes | The monthly price in the caller's currency, or null when not on sale. |
purchase_id | string | Yes | The add-on purchase that is on, or null. |
renews_on | string | Yes | The next renewal date while it renews. |
ends_on | string | Yes | The last day hourly backups run once the renewal was stopped. |
keep_hours | integer | Yes | How long each hourly restore point is kept, in hours. |
last_hourly_at | string | Yes | When the newest hourly backup was taken, or null. |
Errors this endpoint can return
401 · 403 · 404 · 429