防御ログ(リスト)の取得
URI
https://api.scutum.jp/api/v1/alert
APIの概要
防御ログの一覧を取得します。
データの並び順は、日時の降順です。一度のAPI呼び出しで取得できるデータ件数は最大1000件です。
<呼び出しリクエストの例>
URLパラメータは、予約文字をURLエンコードして送信してください。
GET /api/v1/alert?host=www.example.jp&?id=ABC1234&time_order=asc&from=2020-07-06T02%3A26%3A31%2B09%3A00 HTTP/1.1
Host: api.scutum.jp
X-Scutum-API-Key: 17a1f5d161b33b6404faa8f8ccfdfdf2edf
Connection: close
Host: api.scutum.jp
X-Scutum-API-Key: 17a1f5d161b33b6404faa8f8ccfdfdf2edf
Connection: close
URLパラメータ一覧
パラメータ名 | 必須 | 説明 |
---|---|---|
host | ✔ | APIキーを発行したFQDNです。 |
id | ✔ | Scutum管理画面のIDです。 APIキーを発行したFQDNと対応する管理画面IDを指定してください。 |
time_order | 取得する防御ログの並び順です。日時の昇順・降順を指定します。 asc、descを指定可能です。デフォルトはdescです。 |
|
from | 基点を含む、指定の日時以降の防御ログを取得します。 ISO8601に準拠する以下の4つのフォーマットが利用できます。 yyyy-MM-ddThh:mm:ssZ yyyy-MM-ddThh:mm:ss yyyy-MM-dd yyyyMMdd 時刻を指定しない場合、00:00:00+09:00(日本時間0時0分0秒)を指定したことと同義となります。 |
|
to | 基点を含まず、指定の日時より前の防御ログを取得します。 指定可能なフォーマットはfromと同様です。 |
|
ip | 送信元IPアドレスが完全一致する防御ログデータを取得します。 単一のIPアドレスのみ指定可能です。ネットマスクやワイルドカードを用いた指定はできません。 |
|
marker | ページネーションを行うマーカーです。 マーカー発行時に指定された他のパラメータの値を引き継ぎません。 他のパラメータはマーカー発行時と同じ値を指定してリクエストを送信してください。 |
呼び出し結果のレスポンス例
リクエストが成功すると、レスポンスで以下のようなjsonが返ります。
{ "data" : [ { "log_id" : "1568081543650_595_59102", "ip" : "192.168.1.2", "block" : true, "category" : [ "SQLインジェクション" ], "uri" : "/test.jsp", "ts" : "2019-09-10T11:12:24+09:00" }, { "log_id" : "1568081543660_595_69123", "ip" : "192.168.1.3", "block" : true, "category" : [ "Scutum攻撃テスト" ], "uri" : "/sstattack", "ts" : "2019-09-09T11:13:33+09:00" } ], "count" : 2, "truncated" : false }
レスポンスに含まれるパラメータ一覧
パラメータ | データ型 | 説明 |
---|---|---|
data | array[object] | 防御ログの配列です。取得できるログオブジェクトには、requestやresponseなどの一部の項目は含まれません。 これらの情報を取得するには、防御ログ(詳細)の取得を参照してください。 |
log_id | string | 防御ログのIDです。 |
ip | string | リクエスト送信元のIPアドレスです。 |
block | boolean | 通信をブロックしたかどうかを表します。 「WAF防御機能OFF」で運用している場合や、偽陽性の通信の場合にfalseになります。 |
category | array[string] | 検知した攻撃の分類です。一つのリクエストに対して、複数の攻撃分類を検知する場合があります。 |
uri | string | リクエストのアクセス先URIです。 |
ts | string | Scutumが通信を検知・ブロックした日時です。 |
count | number | data に含まれる防御ログの件数です。 |
truncated | boolean | data に含まれる防御ログが1000件を超えるかどうかを表します。 |
next_marker | string | ページネーションを行うマーカーです。truncated がtrue の場合に限り、レスポンスに含まれます。 |
- APIマニュアル
- APIの概要と共通仕様
- 防御ログ(リスト)の取得
- 防御ログ(詳細)の取得
- SSL証明書の更新