hosting
PUT /v1/sites/{siteId}/protection/hotlink
Replace a site's hotlink-protection rules.
توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس sites.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
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