hosting
GET /v1/sites/{siteId}/protection/file-permissions
Run the vendor's file-permission check on a site.
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}/protection/file-permissions \
-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
⛔ This GET RUNS the scan — it is not a cached read. The vendor's read is the check, so it walks the site's filesystem. It is an explicit "check my permissions" action and must never fire on mount or on window focus. check_id is the handle the fix needs, and it is nullable: null means the vendor gave us no handle, so actionable is false and there is nothing to apply. recommended on each failure is nullable for the same reason — the platform sometimes names a file without naming a mode, and a guessed 644 would be applied to the customer's file. 404 for a site with no vendor hosting package. Requires sites.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
check_id | integer | Yes | The vendor's handle for this check. Null when the vendor gave us none, in which case there is nothing to apply and actionable is false. ⛔ A client never sends it back:… |
public_html_wrong | boolean | Yes | Whether the document root's own mode is wrong. |
root_wrong | boolean | Yes | Whether the package root's own mode is wrong. |
failures | SitePermissionFailure[] | Yes | The individual files the check flagged. |
actionable | boolean | Yes | Whether Fix these can do anything: a live check handle and something to fix. Its own field so the button is not offered against a report that can only be refused. |
Errors this endpoint can return
401 · 403 · 404 · 429 · 503