VAddyブログ

- 継続的セキュリティテストへの道 -

VAddy WebAPIに検査結果一覧の取得機能を追加しました

VAddyでは初期から、検査開始、検査結果取得、クロール一覧取得のWebAPIを提供してきました。 検査結果を1件取得するAPIはありましたが、複数の検査結果を取得する機能がありませんでした。
今回、複数の検査結果を取得するAPIを提供することにより、検査している全てのプロジェクトの情報を取得して把握することができます。

利用用途

たとえば、1ヶ月以上検査を実行していないプロジェクトを把握する、 最後の検査結果で脆弱性情報が出た状態のまま一定時間経過している、 脆弱性検査で見つかった脆弱性の数の推移をグラフ化する、 など色々な利用用途があります。

API仕様

APIの仕様はこちらをご覧ください。
https://github.com/vaddy/WebAPI-document/blob/master/VAddy-WebApi-ScanResultList-ja.md

検査結果の一覧情報は、json形式で取得でき、下記のようにitemsの中に複数件の検査結果情報が返されます。 情報は最新の検査結果順から最大20件を返します。

 {"project_number":123,
 "page":1,
 "limit":20,
 "items":[
    {"scan_id":"123-aaaaa-bbbbb-ccccc",
     "status":"Complete",
     "scan_count":26,
     "alert_count":1,
     "complete":100,
     "crawl_id":221,
     "crawl_label":null,
     "time_zone":"UTC",
     "start_time":"2019-12-02T04:07:37+0000",
     "end_time":"2019-12-02T04:07:42+0000",
     "scan_result_url":"https://console.vaddy.net/scan_status/123/123-aaaaa-bbbbb-ccccc"
    },
    {"scan_id":"123-eeeee-fffff-ggggg",
     "status":"Cancel",
     "scan_count":null,
     "alert_count":null,
     "complete":null,
     "crawl_id":221,
     "crawl_label":null,
     "time_zone":"UTC",
     "start_time":"2020-01-30T02:05:24+0000",
     "end_time":"2020-01-30T02:05:27+0000",
     "scan_result_url":"https://console.vaddy.net/scan_status/123/123-eeeee-fffff-ggggg"
    }
 ]
}

jsonの内容の詳細は、APIドキュメントをご覧ください。