hosting

PUT `/v1/sites/{siteId}/protection/countries`

Replace a site's country rule.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

التفاصيل

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

PUT /v1/sites/{siteId}/protection/countries