身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/geo-restriction \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The site's country rule and what each enforcement layer is doing about it. **Not under `/cdn/`, deliberately.** A country rule is a *site* control with up to two enforcement points — the CDN edge and the origin server — and a site with no CDN still gets it at the origin. It applies on every product line. **The edge state is read from the provider, not from our record.** "We asked for it" and "it is set" are different claims: they diverge when a customer edits the rule in their own CDN dashboard, after a CDN switch, or after a failed apply. Read `edge` and `origin` separately — a rule live at one layer only is a real, partial state, and `enforcing: false` with a `detail` means the layer is not protecting the site whatever `mode` says. Requires `sites.view`.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
siteId (path) | Uuid | 是 | Site ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
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 differ… |
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 differ… |
此端点可能返回的错误
401 · 403 · 404 · 429