hosting
POST /v1/sites/{siteId}/protection/directories/remove
Take the password off a folder 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 POST https://api.zinndigital.com/v1/sites/{siteId}/protection/directories/remove \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "directory": <string> }'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
Removes the folder's HTTP password. Everything in it becomes publicly readable again the moment this returns, so the client names the folder back before calling. ⛔ A `POST` to a `/remove` sub-path rather than a `DELETE` with the folder in the URL, and the folder travels in the **body**: a directory contains slashes, and a percent-encoded `/` inside a path segment is rejected or silently decoded by enough proxies that it is not a contract worth betting a security control on. The whole protection state comes back, so the card re-renders from the server's answer. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
siteId (path) | Uuid | Yes | Site ID (UUIDv7). |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
directory | string | Yes | The folder, exactly as `SiteProtection.directories` reports it. Normalised the same way on both sides, so the folder that is unprotected is the one that was named. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
countries | string[] | Yes | The countries in the rule, as ISO 3166-1 alpha-2 codes. |
countries_allow_only | boolean | Yes | ⛔ `true` means `countries` is an **allow**-list: only those countries reach the site. Its own field rather than a mode string, because inverting it inverts who can reach the cus… |
blocked_addresses | string[] | Yes | The blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed. |
visitor_blocking_permitted | boolean | Yes | Whether the package type permits blocking visitors at all. One flag governs both lists. |
hotlink_configured | boolean | Yes | Whether any hotlink rule exists. ⛔ `false` means *no rules have been set up* — **not** "protection is on with no allowed hosts", which would read as a site blocking everybody. |
hotlink_allow_direct | boolean | Yes | Whether a request with no referrer is allowed through. **Null** when the vendor did not state it — distinct from `false`, because a toggle rendered from an unknown lies about th… |
hotlink_allowed_hostnames | string[] | Yes | The sites permitted to embed these files. |
hotlink_redirect_url | string | Yes | Where a refused request is sent instead, or `""` when it is simply refused. |
hotlink_extensions | string[] | Yes | The file extensions the rule covers, normalised without a leading dot. |
hotlink_permitted | boolean | Yes | Whether the package type includes hotlink protection. |
directories | SiteProtectedDirectory[] | Yes | The password-protected folders. ⛔ Read from a vendor field that documents `null` as *"the request could not complete"* — the opposite of "nothing is protected" — so an unreadabl… |
password_protection_permitted | boolean | Yes | Whether the package type includes password-protected directories. |
malware_scan_permitted | boolean | Yes | Whether the package type includes the vendor's malware scan — the capability behind `scanSite` on this deploy target. |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429 · 503