拒否/許可IPアドレスの取得
URI
https://api.scutum.jp/api/v1/blockip
APIの概要
管理画面「IPアドレスの拒否/許可の設定」の現在の状態を取得します。
取得される情報は2点あり、1つはアクセス制御の種別、もう1つはIPアドレスのリストです。
アクセス制御の種別は
1. NOT_CHECK_IP
IPアドレスによるアクセス制限をおこなわない
2. BLOCK_IF_MATCH
リストのいずれかに一致する場合、アクセスを拒否する。それ以外のIPアドレスからのアクセスは許可する
3. ALLOW_IF_MATCH
リストのいずれかに一致する場合、アクセスを許可する。それ以外のIPアドレスからのアクセスは拒否する
のうちの1つです。
リストは単体のIPアドレスや、ネットワークをレンジで指定したものの集合です。下記に例を示します。
10.1.2.3 10.11.12.0/24
<呼び出しリクエストの例>
GET /api/v1/blockip?host=www.example.jp&id=ABC1234 HTTP/1.1
X-Scutum-API-Key: 17a1f5d161b33b6404faa8f8ccfdfdf2edf
Host: api.scutum.jp
Connection: close
X-Scutum-API-Key: 17a1f5d161b33b6404faa8f8ccfdfdf2edf
Host: api.scutum.jp
Connection: close
URLパラメータ一覧
| パラメータ名 | 必須 | 説明 |
|---|---|---|
| host | ✔ | APIキーを発行したFQDNです。 |
| id | ✔ | Scutum管理画面のIDです。 APIキーを発行したFQDNと対応する管理画面IDを指定してください。 |
呼び出し結果のレスポンス例
リクエストが成功すると、レスポンスで以下のようなjsonが返ります。
{
"blockip_type": "BLOCK_IF_MATCH",
"blockip": [
"10.1.2.3",
"10.11.12.0/24"
]
}
レスポンスに含まれるパラメータ一覧
| パラメータ | データ型 | 説明 |
|---|---|---|
| blockip_type | string | 本ページ上部にある「アクセス制御の種別」を参照ください。値は「NOT_CHECK_IP」「BLOCK_IF_MATCH」「ALLOW_IF_MATCH」のいずれかになります。 |
| blockip | array[string] | IPアドレス一覧です。詳細はhttps://support.scutum.jp/manual/waf-setting/ipcontroll.htmlを参照ください。 |

