hosting
GET /v1/sites/{siteId}/cleaner
Read a site's Site Cleaner state.
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}/cleaner \
-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 Site Cleaner (site_cleaner, s1014 B01, docs/1081 §7) for this site: whether the add-on is on sale to the organisation and active on the account (one subscription cleans every website), its prices in the caller's currency (site_cleaner monthly, site_cleaner_yearly yearly), the scheduled clean, the latest scan (the free preview, with every item that could go), the job in flight and the recent jobs. supported is false for a site not hosted on our own servers or not online. Buy it through purchaseExtra. 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 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 · 429