hosting

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

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

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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).

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`mode`	`string<off, allow, block>`	هو	—
`countries`	`string[]`	هو	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`	نه	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…

ځواب

نوم	ډول	اړین	دا څه شی دی
`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 · 422 · 429

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