hosting
PUT /v1/sites/{siteId}/geo-restriction
Restrict this site to chosen countries, or refuse named ones.
การยืนยันตัวตน
ส่ง API key เป็น bearer token เอนด์พอยต์นี้ไม่ได้ระบุสิทธิ์การใช้งานเฉพาะในข้อกำหนด ดังนั้นควรให้คีย์ของคุณมีสิทธิ์น้อยที่สุดเท่าที่จำเป็นและให้ตรวจสอบจากการตอบกลับแทนที่จะคาดเดา
ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น
ทดลองใช้เลย
แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/geo-restriction \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "mode": <string<off, allow, block>>, "countries": <string[]> }'เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API
รายละเอียด
Convergent, and mode plus countries must be sent together. The same list means "only these may enter" under allow and "only these are refused" under block, so a partial update that changed one field would invert who can reach the site without naming a country. The rule is pushed to every layer that can carry it — the CDN edge where the provider supports it, and the origin. A provider that cannot express the requested direction is reported in edge.detail and the rule is never quietly narrowed to fit it. When no layer can carry it the call is refused with 422 rather than storing an intent nothing enforces. exempt_search_engines defaults to true, and you usually want it. A single-country allow-list otherwise blocks Googlebot, which crawls from US addresses, and removes the site from search. It is honoured only where the provider verifies the crawler by forward/reverse DNS; search_engines_exempt_at_edge reports whether it is actually in force, which is not the same as whether it was requested. This is a customer-visible, revenue-affecting switch — a wrong country refuses every real visitor to a live site. Clients must confirm before sending, and every call is audit-logged with the acting principal. Requires both hosting.cdn.manage and sites.panel_access.
พารามิเตอร์
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
siteId (path) | Uuid | ใช่ | Site ID (UUIDv7). |
เนื้อหาคำขอ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
mode | string<off, allow, block> | ใช่ | — |
countries | string[] | ใช่ | ISO-3166 alpha-2. Must name at least one country unless mode is off; an empty allow-list would take the site off the internet worldwide and is refused. |
exempt_search_engines | boolean | ไม่ใช่ | Leave verified search-engine crawlers able to reach the site. Defaults to true: a single-country allow-list otherwise removes the site from search, because Googlebot crawls from… |
การตอบกลับ
| ชื่อ | ประเภท | จำเป็นต้องมี | ลักษณะของสิ่งนี้ |
|---|---|---|---|
mode | string<off, allow, block> | ใช่ | allow admits only the listed countries and refuses everywhere else; block refuses the listed ones and serves everywhere else; off is no rule at all. |
countries | string[] | ใช่ | ISO-3166 alpha-2, upper-case. Empty when mode is off. |
exempt_search_engines | boolean | ใช่ | Whether verified search-engine crawlers were asked to bypass the rule. |
search_engines_exempt_at_edge | boolean | ใช่ | Whether that exemption is actually in force, which is not the same as whether it was requested — only a provider that verifies a crawler by forward/reverse DNS can carry it.… |
edge | GeoRestrictionLayer | ใช่ | What ONE enforcement layer can do, and what it is doing right now. Four fields rather than one flag because "this provider cannot do it" and "it failed this morning" need… |
origin | GeoRestrictionLayer | ใช่ | What ONE enforcement layer can do, and what it is doing right now. Four fields rather than one flag because "this provider cannot do it" and "it failed this morning" need… |
ข้อผิดพลาดที่เอนด์พอยต์นี้สามารถส่งกลับได้
401 · 403 · 404 · 422 · 429