hosting
PUT /v1/sites/{siteId}/geo-restriction
Restrict this site to chosen countries, or refuse named ones.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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