hosting
GET /v1/sites/{siteId}/protection
Get every protection control for a site.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה 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