hosting

PUT /v1/sites/{siteId}/geo-restriction

Restrict this site to chosen countries, or refuse named ones.

Усі кінцеві точки hosting

Автентифікація

Надішліть ключ API як маркер носія (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).

Тіло запиту

НазваТипОбов'язковеЩо це таке
modestring<off, allow, block>Так
countriesstring[]Так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_enginesbooleanНі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 fr…

Відповідь

НазваТипОбов'язковеЩо це таке
modestring<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.
countriesstring[]ТакISO-3166 alpha-2, upper-case. Empty when `mode` is `off`.
exempt_search_enginesbooleanТакWhether verified search-engine crawlers were asked to bypass the rule.
search_engines_exempt_at_edgebooleanТак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.…
edgeGeoRestrictionLayerТак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…
originGeoRestrictionLayerТак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 · 422 · 429