hosting
PUT /v1/sites/{siteId}/cleaner/schedule
Set a site's scheduled clean.
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 PUT https://api.zinndigital.com/v1/sites/{siteId}/cleaner/schedule \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "schedule": <string<off, daily, weekly, monthly>> }'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
Turns the scheduled clean off, or on daily, weekly or monthly. A scheduled clean removes every default-ticked item except the ids in skip, with the same backup first and roll-back as a manual clean. Turning a schedule on needs the add-on; off always works. Requires sites.view and hosting.backup.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
schedule | string<off, daily, weekly, monthly> | Yes | — |
skip | string[] | No | Item ids a scheduled clean never removes. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
site_id | string | Yes | — |
offered | boolean | Yes | Whether the add-on is on sale to this organisation. |
active | boolean | Yes | Whether the account holds it and may clean now. |
supported | boolean | Yes | — |
unsupported_reason | string | No | — |
can_buy | boolean | Yes | — |
refusal | string | No | — |
prices | object[] | Yes | — |
purchase_id | string | No | — |
renews_on | string | No | — |
ends_on | string | No | — |
schedule | string<off, daily, weekly, monthly> | Yes | — |
next_run_at | string | No | — |
skip | string[] | Yes | — |
last_scan | SiteCleanerJob | No | — |
in_flight | SiteCleanerJob | No | — |
jobs | SiteCleanerJob[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429