hosting
PUT /v1/sites/{siteId}/geo-restriction
Restrict this site to chosen countries, or refuse named ones.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
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[]> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
siteId (path) | Uuid | Oui | Site ID (UUIDv7). |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
mode | string<off, allow, block> | Oui | — |
countries | string[] | Oui | 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 | Non | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
mode | string<off, allow, block> | Oui | 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[] | Oui | ISO-3166 alpha-2, upper-case. Empty when mode is off. |
exempt_search_engines | boolean | Oui | Whether verified search-engine crawlers were asked to bypass the rule. |
search_engines_exempt_at_edge | boolean | Oui | 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 | Oui | 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 | Oui | 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… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422 · 429