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 ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง 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