hosting

GET `/v1/sites/{siteId}/protection`

Get every protection control for a site.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա sites.view թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/protection \
  -H "Authorization: Bearer zdk_live_…"

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

Blocked countries, blocked addresses, hotlink rules and password-protected folders, in **one** read. One endpoint rather than four, deliberately: each vendor read costs a driver build and an HTTP transport, the card renders all four together, and four endpoints would be four transports and four package lookups per render on an API that rate-limits per source IP (§2.16). The `*_permitted` flags travel with the state so a screen never offers a control whose request is already known to be refused. `hotlink_allow_direct` is **null** when the vendor did not state it — distinct from `false`, because a toggle rendered from an unknown lies about the customer's site. `404` for a site with no vendor hosting package. Requires `sites.view`.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`siteId (path)`	`Uuid`	Այո	Site ID (UUIDv7).

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`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 · 429 · 503

GET /v1/sites/{siteId}/protection