hosting

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

Replace a site's country rule.

Minden hosting végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).

Kérés törzse

NévTípusKötelezőMi ez
countriesstring[]IgenThe whole rule, as two-letter ISO 3166-1 alpha-2 codes. An empty array clears the restriction entirely.
allow_onlybooleanNemfalse blocks the listed countries. true makes the list an allow-list — only those countries reach the site, and everyone else is blocked.

Válasz

NévTípusKötelezőMi ez
countriesstring[]IgenThe countries in the rule, as ISO 3166-1 alpha-2 codes.
countries_allow_onlybooleanIgentrue 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_addressesstring[]IgenThe blocked addresses and CIDR ranges, canonicalised — what is here is what is in force, not what was typed.
visitor_blocking_permittedbooleanIgenWhether the package type permits blocking visitors at all. One flag governs both lists.
hotlink_configuredbooleanIgenWhether any hotlink rule exists. ⛔ false means no rules have been set upnot "protection is on with no allowed hosts", which would read as a site blocking everybody.
hotlink_allow_directbooleanIgenWhether 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_hostnamesstring[]IgenThe sites permitted to embed these files.
hotlink_redirect_urlstringIgenWhere a refused request is sent instead, or "" when it is simply refused.
hotlink_extensionsstring[]IgenThe file extensions the rule covers, normalised without a leading dot.
hotlink_permittedbooleanIgenWhether the package type includes hotlink protection.
directoriesSiteProtectedDirectory[]IgenThe 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_permittedbooleanIgenWhether the package type includes password-protected directories.
malware_scan_permittedbooleanIgenWhether the package type includes the vendor's malware scan — the capability behind scanSite on this deploy target.

Hibák, amelyeket ez a végpont visszaadhattatlan

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