hosting
GET /v1/sites/{siteId}/protection
Get every protection control for a site.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/protection \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
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.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | Uuid | بله | Site ID (UUIDv7). |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
countries | string[] | بله | The countries in the rule, as ISO 3166-1 alpha-2 codes. |
countries_allow_only | boolean | بله | ⛔ 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… |
blocked_addresses | string[] | بله | The blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed. |
visitor_blocking_permitted | boolean | بله | Whether the package type permits blocking visitors at all. One flag governs both lists. |
hotlink_configured | boolean | بله | 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 | بله | 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 the… |
hotlink_allowed_hostnames | string[] | بله | The sites permitted to embed these files. |
hotlink_redirect_url | string | بله | Where a refused request is sent instead, or "" when it is simply refused. |
hotlink_extensions | string[] | بله | The file extensions the rule covers, normalised without a leading dot. |
hotlink_permitted | boolean | بله | Whether the package type includes hotlink protection. |
directories | SiteProtectedDirectory[] | بله | 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 unreadable… |
password_protection_permitted | boolean | بله | Whether the package type includes password-protected directories. |
malware_scan_permitted | boolean | بله | Whether the package type includes the vendor's malware scan — the capability behind scanSite on this deploy target. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429 · 503