hosting
GET /v1/sites/{siteId}/protection
Get every protection control for a site.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na sites.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/protection \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
Blocked countries, blocked addresses, hotlink rules and password-protected folders, in **one** read. One endpoint rather than four, deliberately: each vendor read costs a driver build and an HTTP transport, the card renders all four together, and four endpoints would be four transports and four package lookups per render on an API that rate-limits per source IP (§2.16). The `*_permitted` flags travel with the state so a screen never offers a control whose request is already known to be refused. `hotlink_allow_direct` is **null** when the vendor did not state it — distinct from `false`, because a toggle rendered from an unknown lies about the customer's site. `404` for a site with no vendor hosting package. Requires `sites.view`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
siteId (path) | Uuid | Oo | Site ID (UUIDv7). |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
countries | string[] | Oo | The countries in the rule, as ISO 3166-1 alpha-2 codes. |
countries_allow_only | boolean | Oo | ⛔ `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[] | Oo | The blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed. |
visitor_blocking_permitted | boolean | Oo | Whether the package type permits blocking visitors at all. One flag governs both lists. |
hotlink_configured | boolean | Oo | 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 | Oo | 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[] | Oo | The sites permitted to embed these files. |
hotlink_redirect_url | string | Oo | Where a refused request is sent instead, or `""` when it is simply refused. |
hotlink_extensions | string[] | Oo | The file extensions the rule covers, normalised without a leading dot. |
hotlink_permitted | boolean | Oo | Whether the package type includes hotlink protection. |
directories | SiteProtectedDirectory[] | Oo | 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 | Oo | Whether the package type includes password-protected directories. |
malware_scan_permitted | boolean | Oo | Whether the package type includes the vendor's malware scan — the capability behind `scanSite` on this deploy target. |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 429 · 503