hosting

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

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

Tutti gli endpoint hosting

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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[]> }'

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

**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`.

Parametri

NomeTipoObbligatorioChe cos'è
siteId (path)UuidSite ID (UUIDv7).

Corpo della richiesta

NomeTipoObbligatorioChe cos'è
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_enginesbooleanNoLeave 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…

Risposta

NomeTipoObbligatorioChe cos'è
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_enginesbooleanWhether verified search-engine crawlers were asked to bypass the rule.
search_engines_exempt_at_edgebooleanWhether 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.…
edgeGeoRestrictionLayerWhat 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…
originGeoRestrictionLayerWhat 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…

Errori che questo endpoint può restituire

401 · 403 · 404 · 422 · 429