hosting
PUT /v1/sites/{siteId}/protection/countries
Replace a site's country rule.
توثيقِ شناخت
ایک بیرر ٹوکن کے طور پر ایک API کی بھیجیں۔ کی کے پاس sites.view اجازت ہونی چاہیے؛ اس کے بغیر کی کو 404 کے بجائے 403 کے ساتھ مسترد کر دیا جاتا ہے۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/protection/countries \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "countries": <string[]> }'لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں
تفصیلات
A replace, not a patch: the platform's endpoint replaces the list, and an empty list is its documented way to clear every country restriction — so "unblock everywhere" needs no second verb. ⛔ allow_only inverts who can reach the customer's site: false blocks the listed countries, true blocks everyone except them. It is its own boolean rather than a mode string precisely because a free-form word invites each consumer to re-derive that, and getting it backwards takes the site off the internet for everybody. A value that is not a two-letter country code is refused 422 before the vendor is called, with our sentence. 404 for a site with no vendor hosting package. Requires sites.view and sites.panel_access.
پیرامیٹرز
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
siteId (path) | Uuid | ہاں | Site ID (UUIDv7). |
درخواست کا باڈی
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
countries | string[] | ہاں | The whole rule, as two-letter ISO 3166-1 alpha-2 codes. An empty array clears the restriction entirely. |
allow_only | boolean | نہیں | false blocks the listed countries. true makes the list an allow-list — only those countries reach the site, and everyone else is blocked. |
جواب
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
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 · 409 · 422 · 429 · 503