hosting
POST /v1/sites/{siteId}/cleaner/scan
Scan a site for things to clean (free).
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}/cleaner/scan \
-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
Starts a read-only scan of the site (a job). Free for every account: it lists unused plugins and themes, leftovers of removed plugins, database junk, plugin log tables and junk files with their sizes. Poll getSiteCleaner for the result. One job runs per site at a time (422 while another runs). Requires sites.view and hosting.backup.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
kind | string<scan, clean, undo> | Yes | — |
trigger | string<manual, schedule, staff> | Yes | — |
state | string<queued, running, done, nothing, restored, failed> | Yes | — |
cms | string | No | The application detected: wordpress, joomla, drupal, prestashop, opencart, grav, mediawiki or other. |
message | string | Yes | — |
totals | object | No | count, mb, files, rows of the selected (clean) or default-ticked (scan) items. |
selected | string[] | No | — |
saved_mb | number | No | — |
saved_files | integer | No | — |
saved_db_mb | number | No | — |
removed_count | integer | No | — |
has_backup | boolean | Yes | Whether a backup was taken before the clean. |
backup_expires_at | string | No | — |
undo_of | string | No | — |
created_at | string | Yes | — |
started_at | string | No | — |
finished_at | string | No | — |
items | SiteCleanerItem[] | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429