hosting

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

Replace a site's country rule.

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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.

Parameters

Name	Type	Required	What it is
`siteId (path)`	`Uuid`	Yes	Site ID (UUIDv7).

Request body

Name	Type	Required	What it is
`countries`	`string[]`	Yes	The whole rule, as two-letter ISO 3166-1 alpha-2 codes. An empty array clears the restriction entirely.
`allow_only`	`boolean`	No	`false` blocks the listed countries. `true` makes the list an allow-list — only those countries reach the site, and everyone else is blocked.

Response

Name	Type	Required	What it is
`countries`	`string[]`	Yes	The countries in the rule, as ISO 3166-1 alpha-2 codes.
`countries_allow_only`	`boolean`	Yes	⛔ `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[]`	Yes	The blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed.
`visitor_blocking_permitted`	`boolean`	Yes	Whether the package type permits blocking visitors at all. One flag governs both lists.
`hotlink_configured`	`boolean`	Yes	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`	Yes	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[]`	Yes	The sites permitted to embed these files.
`hotlink_redirect_url`	`string`	Yes	Where a refused request is sent instead, or `""` when it is simply refused.
`hotlink_extensions`	`string[]`	Yes	The file extensions the rule covers, normalised without a leading dot.
`hotlink_permitted`	`boolean`	Yes	Whether the package type includes hotlink protection.
`directories`	`SiteProtectedDirectory[]`	Yes	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`	Yes	Whether the package type includes password-protected directories.
`malware_scan_permitted`	`boolean`	Yes	Whether the package type includes the vendor's malware scan — the capability behind `scanSite` on this deploy target.

Errors this endpoint can return

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

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