hosting

PUT `/v1/sites/{siteId}/protection/countries`

Replace a site's country rule.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د sites.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

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

هڅه وکړئ

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

curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/protection/countries \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "countries": <string[]> }'

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

تفصیلات

A **replace, not a patch**: the platform's endpoint replaces the list, and an empty list is its documented way to clear every country restriction — so *"unblock everywhere"* needs no second verb. ⛔ `allow_only` inverts who can reach the customer's site: `false` blocks the listed countries, `true` blocks everyone **except** them. It is its own boolean rather than a mode string precisely because a free-form word invites each consumer to re-derive that, and getting it backwards takes the site off the internet for everybody. A value that is not a two-letter country code is refused `422` before the vendor is called, with our sentence. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.

پارامترونه

نوم	ډول	اړین	دا څه شی دی
`siteId (path)`	`Uuid`	هو	Site ID (UUIDv7).

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`countries`	`string[]`	هو	The whole rule, as two-letter ISO 3166-1 alpha-2 codes. An empty array clears the restriction entirely.
`allow_only`	`boolean`	نه	`false` blocks the listed countries. `true` makes the list an allow-list — only those countries reach the site, and everyone else is blocked.

ځواب

نوم	ډول	اړین	دا څه شی دی
`countries`	`string[]`	هو	The countries in the rule, as ISO 3166-1 alpha-2 codes.
`countries_allow_only`	`boolean`	هو	⛔ `true` means `countries` is an allow-list: only those countries reach the site. Its own field rather than a mode string, because inverting it inverts who can reach the cus…
`blocked_addresses`	`string[]`	هو	The blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed.
`visitor_blocking_permitted`	`boolean`	هو	Whether the package type permits blocking visitors at all. One flag governs both lists.
`hotlink_configured`	`boolean`	هو	Whether any hotlink rule exists. ⛔ `false` means no rules have been set up — not "protection is on with no allowed hosts", which would read as a site blocking everybody.
`hotlink_allow_direct`	`boolean`	هو	Whether a request with no referrer is allowed through. Null when the vendor did not state it — distinct from `false`, because a toggle rendered from an unknown lies about th…
`hotlink_allowed_hostnames`	`string[]`	هو	The sites permitted to embed these files.
`hotlink_redirect_url`	`string`	هو	Where a refused request is sent instead, or `""` when it is simply refused.
`hotlink_extensions`	`string[]`	هو	The file extensions the rule covers, normalised without a leading dot.
`hotlink_permitted`	`boolean`	هو	Whether the package type includes hotlink protection.
`directories`	`SiteProtectedDirectory[]`	هو	The password-protected folders. ⛔ Read from a vendor field that documents `null` as "the request could not complete" — the opposite of "nothing is protected" — so an unreadabl…
`password_protection_permitted`	`boolean`	هو	Whether the package type includes password-protected directories.
`malware_scan_permitted`	`boolean`	هو	Whether the package type includes the vendor's malware scan — the capability behind `scanSite` on this deploy target.

تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي

401 · 403 · 404 · 409 · 422 · 429 · 503

PUT /v1/sites/{siteId}/protection/countries