hosting
PUT /v1/sites/{siteId}/geo-restriction
Restrict this site to chosen countries, or refuse named ones.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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[]> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
siteId (path) | Uuid | Ano | Site ID (UUIDv7). |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
mode | string<off, allow, block> | Ano | — |
countries | string[] | Ano | 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 | Ne | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
mode | string<off, allow, block> | Ano | 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[] | Ano | ISO-3166 alpha-2, upper-case. Empty when mode is off. |
exempt_search_engines | boolean | Ano | Whether verified search-engine crawlers were asked to bypass the rule. |
search_engines_exempt_at_edge | boolean | Ano | 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 | Ano | 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 | Ano | 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… |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422 · 429