hosting

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

Replace a site's hotlink-protection rules.

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione sites.view; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Decides who may embed the site's files from another site. `allowed_hostnames` are the sites permitted to do so; `extensions` are the file types the rule covers; `redirect_url` is where a refused request is sent instead, and an empty string means the request is simply refused. A replace rather than a patch, for the same reason as the two block lists: the vendor endpoint replaces the set. Extensions are normalised before they are sent — a leading dot and capitals are stripped — so what the customer typed and what is enforced cannot differ. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`siteId (path)`	`Uuid`	Sì	Site ID (UUIDv7).

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`allow_direct`	`boolean`	Sì	Whether a request with no referrer — somebody opening the file's URL directly, and every search-engine image crawler — is allowed through.
`allowed_hostnames`	`string[]`	Sì	The sites permitted to embed these files. The customer's own domain is included by the vendor; list the others.
`redirect_url`	`string`	No	Where a refused request is sent instead. Empty means the request is refused outright rather than redirected.
`extensions`	`string[]`	Sì	The file extensions the rule covers, without a leading dot. An empty array means the rule covers nothing and is therefore off.

Risposta

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

Errori che questo endpoint può restituire

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

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