hosting
PUT /v1/sites/{siteId}/protection/countries
Replace a site's country rule.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền sites.view; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
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[]> }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
siteId (path) | Uuid | Có | Site ID (UUIDv7). |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
countries | string[] | Có | The whole rule, as two-letter ISO 3166-1 alpha-2 codes. An empty array clears the restriction entirely. |
allow_only | boolean | Không | false blocks the listed countries. true makes the list an allow-list — only those countries reach the site, and everyone else is blocked. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
countries | string[] | Có | The countries in the rule, as ISO 3166-1 alpha-2 codes. |
countries_allow_only | boolean | Có | ⛔ 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… |
blocked_addresses | string[] | Có | The blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed. |
visitor_blocking_permitted | boolean | Có | Whether the package type permits blocking visitors at all. One flag governs both lists. |
hotlink_configured | boolean | Có | 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 | Có | 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 the… |
hotlink_allowed_hostnames | string[] | Có | The sites permitted to embed these files. |
hotlink_redirect_url | string | Có | Where a refused request is sent instead, or "" when it is simply refused. |
hotlink_extensions | string[] | Có | The file extensions the rule covers, normalised without a leading dot. |
hotlink_permitted | boolean | Có | Whether the package type includes hotlink protection. |
directories | SiteProtectedDirectory[] | Có | 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 unreadable… |
password_protection_permitted | boolean | Có | Whether the package type includes password-protected directories. |
malware_scan_permitted | boolean | Có | Whether the package type includes the vendor's malware scan — the capability behind scanSite on this deploy target. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 409 · 422 · 429 · 503