拒否/許可IPアドレスの更新
URI
https://api.scutum.jp/api/v1/update_blockip
APIの概要
管理画面「IPアドレスの拒否/許可の設定」に該当する設定を更新します。
更新対象は2点あり、1つはアクセス制御の種別、もう1つはIPアドレスのリストです。
<呼び出しリクエストの例>
・POSTメソッドで、JSONリクエストを送信します。
（リクエスト内の Content-Typeヘッダ で、application/json 等を指定します。）
POST /api/v1/update_blockip?host=www.example.jp&id=ABC1234 HTTP/1.0
X-Scutum-API-Key: 17a1f5d161b33b6404faa8f8ccfdfdf2edf
Content-Type: application/json
Content-Length: 95
{
"blockip_type": "BLOCK_IF_MATCH",
"blockip": [
"10.1.2.3",
"10.11.12.0/24"
]
}
X-Scutum-API-Key: 17a1f5d161b33b6404faa8f8ccfdfdf2edf
Content-Type: application/json
Content-Length: 95
{
"blockip_type": "BLOCK_IF_MATCH",
"blockip": [
"10.1.2.3",
"10.11.12.0/24"
]
}
URLパラメータ一覧
| パラメータ名 | 必須 | 説明 |
|---|---|---|
| host | ✔ | APIキーを発行したFQDNです。 |
| id | ✔ | Scutum管理画面のIDです。 APIキーを発行したFQDNと対応する管理画面IDを指定してください。 |
リクエストボディ部のパラメータ一覧
| パラメータ名 | 必須 | 説明 |
|---|---|---|
| blockip_type | ✔ | 値は「NOT_CHECK_IP」「BLOCK_IF_MATCH」「ALLOW_IF_MATCH」のいずれかになります。それぞれの意味については「拒否/許可IPアドレスの取得」APIを参照ください。 |
| blockip | ✔ | IPアドレス一覧です。ワイルドカード表記やネットマスク表記も可能です。詳細はhttps://support.scutum.jp/manual/waf-setting/ipcontroll.htmlを参照ください。 |
呼び出し結果のレスポンス例
・更新に成功した場合
レスポンスで以下のようなステータスコード200が返ります。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 78
{
"valid_ip_list": [
"10.1.2.3",
"10.11.12.0/24"
],
"ignored_ip_list": []
}
レスポンスに含まれるパラメータ一覧
| パラメータ | データ型 | 説明 |
|---|---|---|
| valid_ip_list | array[string] | リクエストに含まれていたblockipのうち、正しく認識されたものが含まれます。 |
| ignored_ip_list | array[string] | リクエストに含まれていたblockipのうち、形式が不正であり、IPアドレスやネットワークアドレスとして認識されなかったものが含まれます。 |