hosting
POST /v1/sites/{siteId}/hourly-backups/stop
Stop a site's hourly backups renewing.
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 POST https://api.zinndigital.com/v1/sites/{siteId}/hourly-backups/stop \
-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
Stops the monthly renewal of the hourly_backups add-on bought for this site. Hourly backups keep running until the day before the next renewal date and are not refunded; the hourly points already taken age out after keep_hours as usual. A site with no hourly backups is 422. Requires sites.view and billing.payment.manage.
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 · 422 · 429