hosting
POST /v1/sites/{siteId}/protection/directories/remove
Take the password off a folder on a site.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
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> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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`.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
directory | string | Oui | 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. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
countries | string[] | Oui | The countries in the rule, as ISO 3166-1 alpha-2 codes. |
countries_allow_only | boolean | Oui | ⛔ `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[] | Oui | The blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed. |
visitor_blocking_permitted | boolean | Oui | Whether the package type permits blocking visitors at all. One flag governs both lists. |
hotlink_configured | boolean | Oui | 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 | Oui | 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[] | Oui | The sites permitted to embed these files. |
hotlink_redirect_url | string | Oui | Where a refused request is sent instead, or `""` when it is simply refused. |
hotlink_extensions | string[] | Oui | The file extensions the rule covers, normalised without a leading dot. |
hotlink_permitted | boolean | Oui | Whether the package type includes hotlink protection. |
directories | SiteProtectedDirectory[] | Oui | 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 | Oui | Whether the package type includes password-protected directories. |
malware_scan_permitted | boolean | Oui | Whether the package type includes the vendor's malware scan — the capability behind `scanSite` on this deploy target. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 409 · 422 · 429 · 503