hosting

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

Replace a site's hotlink-protection rules.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

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.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`siteId (path)`	`Uuid`	نعم	Site ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`allow_direct`	`boolean`	نعم	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[]`	نعم	The sites permitted to embed these files. The customer's own domain is included by the vendor; list the others.
`redirect_url`	`string`	لا	Where a refused request is sent instead. Empty means the request is refused outright rather than redirected.
`extensions`	`string[]`	نعم	The file extensions the rule covers, without a leading dot. An empty array means the rule covers nothing and is therefore off.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`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…
`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 the…
`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 unreadable…
`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 · 409 · 422 · 429 · 503

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