hosting

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

Replace a site's hotlink-protection rules.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem 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[]> }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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`.

Parameter

Name	Typ	Erforderlich	Was es ist
`siteId (path)`	`Uuid`	Ja	Site ID (UUIDv7).

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`allow_direct`	`boolean`	Ja	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[]`	Ja	The sites permitted to embed these files. The customer's own domain is included by the vendor; list the others.
`redirect_url`	`string`	Nein	Where a refused request is sent instead. Empty means the request is refused outright rather than redirected.
`extensions`	`string[]`	Ja	The file extensions the rule covers, without a leading dot. An empty array means the rule covers nothing and is therefore off.

Antwort

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

Fehler, die dieser Endpunkt zurückgeben kann

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

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