hosting
PUT /v1/sites/{siteId}/protection/hotlink
Replace a site's hotlink-protection rules.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה sites.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/protection/hotlink \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "allow_direct": <boolean>, "allowed_hostnames": <string[]>, "extensions": <string[]> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Decides who may embed the site's files from another site. `allowed_hostnames` are the sites permitted to do so; `extensions` are the file types the rule covers; `redirect_url` is where a refused request is sent instead, and an empty string means the request is simply refused. A replace rather than a patch, for the same reason as the two block lists: the vendor endpoint replaces the set. Extensions are normalised before they are sent — a leading dot and capitals are stripped — so what the customer typed and what is enforced cannot differ. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.
פרמטרים
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
siteId (path) | Uuid | כן | Site ID (UUIDv7). |
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
allow_direct | boolean | כן | Whether a request with no referrer — somebody opening the file's URL directly, and every search-engine image crawler — is allowed through. |
allowed_hostnames | string[] | כן | The sites permitted to embed these files. The customer's own domain is included by the vendor; list the others. |
redirect_url | string | לא | Where a refused request is sent instead. Empty means the request is refused outright rather than redirected. |
extensions | string[] | כן | The file extensions the rule covers, without a leading dot. An empty array means the rule covers nothing and is therefore off. |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
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 cus… |
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 th… |
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 unreadabl… |
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 · 409 · 422 · 429 · 503