hosting
PUT /v1/sites/{siteId}/protection/ip-addresses
Replace a site's blocked IP addresses.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/protection/ip-addresses \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "addresses": <string[]> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
A replace, like the country rule: the array is the whole list, and an empty array clears it. Each address is canonicalised before it is stored, so the same address typed two ways cannot appear twice and a rule the customer thinks they removed cannot survive under another spelling. An input that is neither an address nor a CIDR range is refused `422` before the vendor is called. `404` for a site with no vendor hosting package. Requires `sites.view` and `sites.panel_access`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
addresses | string[] | はい | The whole block list. An empty array unblocks everybody. Values are canonicalised, so what comes back in `SiteProtection.blocked_addresses` is what is actually in force. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 · 409 · 422 · 429 · 503