vulnerabilities_by_host
SIDfmVMサーバに登録されているホストの脆弱性一覧を取得するためのエンドポイントです。
ホスト詳細画面のサマリー表に相当するデータを取得します。
エンドポイント | vulnerabilities_by_host |
機能 | ホストの脆弱性一覧取得 |
実装バージョン | 2.7.0 |
認証 | 有り |
HTTPメソッド | GET/POST |
パラメータ
入力値 | 機能 | 入力値の型 | デフォルト値 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
q[api_key] |
パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 |
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[host_id] |
必須のパラメータです。 対象となるホストのIDを指定します。 |
Number | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[offset] | 取得するデータの先頭位置を指定します。 | Number | 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[per_page] |
1~200の値で、1度に取得するデータの数を指定します。指定した値が1~200を超えている場合は10として扱われます。 ※全データ数の指定は不可です。 |
Number | 10 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[index] |
対象とする評価指標を指定します。 sriまたはcvssを指定します。 |
String | sri | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[order] |
一覧データのソート順を指定します。
下記の文字列に_ascを付けると昇順、_descを付けると降順となります。(例: title_asc)
|
String | title_asc | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][warning] | 取得する脆弱性を、warningなら要対応の脆弱性に、othersなら要対応以外の脆弱性に絞り込みます。 | String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][products][product_names] |
SIDfmプロダクト名で、取得する脆弱性を絞り込みます。 指定したプロダクトが関連する脆弱性に絞り込みます。 複数検索可能です。 この絞り込みは、q[filters][products]*に限りOR条件で絞り込みを行います。 |
Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][products][version_names] |
SIDfmプロダクトのバージョン名で、取得する脆弱性を絞り込みます。 指定したバージョンが関連する脆弱性に絞り込みます。 複数検索可能です。 この絞り込みは、q[filters][products]*に限りOR条件で絞り込みを行います。 |
Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][products][lproduct_names] |
ローカルプロダクト名で、取得する脆弱性を絞り込みます。 指定したローカルプロダクトが関連する脆弱性に絞り込みます。 複数検索可能です。 この絞り込みは、q[filters][products]*に限りOR条件で絞り込みを行います。 |
Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][products][lversion_names] |
ローカルプロダクトのバージョン名で、取得する脆弱性を絞り込みます。 指定したバージョンが関連する脆弱性に絞り込みます。 複数検索可能です。 この絞り込みは、q[filters][products]*に限りOR条件で絞り込みを行います。 |
Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][status] |
対応状況で、取得する脆弱性を絞り込みます。 配列で複数指定すると、指定したいずれかの対応状況の脆弱性に絞り込みます。 1つ指定する場合は、文字列でも指定可能です。 絞り込み可能な対応状況は、下記の通りです。
|
String/Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][sris] |
SRIが、指定した危険度のいずれかである脆弱性に絞り込みます。複数検索可能です。 絞り込み可能な危険度は、下記の通りです。
|
Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][cvsses] |
CVSSが、指定したCVSS値のいずれかである脆弱性に絞り込みます。複数検索可能です。 絞り込みには、CVSS値の記号(文字列)を指定します。 絞り込み可能な記号と値は、下記の通りです。
|
Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][area] |
影響範囲で、取得する脆弱性を絞り込みます。 絞り込み可能な影響範囲は、下記の通りです。
|
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][exploitable] | trueを指定すると、取得する脆弱性を攻撃コードがある脆弱性に絞り込みます。 | Boolean | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][journal_date_begin] |
履歴作成日で、取得する脆弱性を絞り込みます。 指定した日付以降に作成された履歴のある脆弱性に絞り込みます。(例: 2022/11/01) |
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][journal_date_end] |
履歴作成日で、取得する脆弱性を絞り込みます。 指定した日付以前に作成された履歴のある脆弱性に絞り込みます。(例: 2022/11/01) |
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][journal_outside_period] | trueを指定すると、q[filters][journal_date_begin]またはq[filters][journal_date_end]あるいはその両方で指定した期間外に作成された履歴のある脆弱性に絞り込みます。 | Boolean | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][journal_status_change] |
trueを指定すると、取得する脆弱性をステータス変更の履歴のある脆弱性に絞り込みます。 この値を指定する場合、q[filters][journal_date_begin]またはq[filters][journal_date_end]の指定が必要です。 |
Boolean | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][journal_duedate_change] |
trueを指定すると、取得する脆弱性を対策予定日変更の履歴のある脆弱性に絞り込みます。 この値を指定する場合、q[filters][journal_date_begin]またはq[filters][journal_date_end]の指定が必要です。 |
Boolean | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][date_begin] |
q[filters][date_outside_period]で指定する日で、取得する脆弱性を絞り込みます。 検出日が指定した日付以降の脆弱性に絞り込みます。(例: 2022/11/01) |
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][date_end] |
q[filters][date_outside_period]で指定する日で、取得する脆弱性を絞り込みます。 検出日が指定した日付以前の脆弱性に絞り込みます。(例: 2022/11/01) |
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][date_outside_period] | trueを指定すると、取得する脆弱性をq[filters][date_begin]またはq[filters][date_end]あるいはその両方で指定した期間外の脆弱性に絞り込みます。 | Boolean | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][date_target] |
q[filters][date_begin]またはq[filters][date_end]で検索する際の対象日を文字列で指定します。 指定可能な対象日は下記の通りです。
|
Boolean | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][due_date_begin] |
対策予定日で、取得する脆弱性を絞り込みます。 対策予定日が指定した日付以降のホストがある脆弱性に絞り込みます。(例: 2022/11/01) q[filters][due_date_nodate]と併用して絞り込みすることはできません。 |
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][due_date_end] |
対策予定日で、取得する脆弱性を絞り込みます。 対策予定日が指定した日付以前のホストがある脆弱性に絞り込みます。(例: 2022/11/01) q[filters][due_date_nodate]と併用して絞り込みすることはできません。 |
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][due_date_nodate] |
trueを指定すると、取得する脆弱性を対策予定日が未設定のホストがある脆弱性に絞り込みます。 q[filters][due_date_begin]及びq[filters][due_date_end]と併用して絞り込みすることはできません。 |
Boolean | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][keyword] |
取得する脆弱性を、指定した文字列が部分一致する脆弱性に絞り込みます。 指定する文字列によって、絞り込みする対象が変わります。
※ CVE IDに部分一致する場合は、そのCVE IDに関連する脆弱性が一致するデータの対象に含まれます。
|
String | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][ctags] | 取得する脆弱性を、指定したカスタムタグのいずれかが設定されている脆弱性に絞り込みます。 | Array<String> | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][cvss_vector][cvss_v3] |
取得する脆弱性を、指定したCVSS指標(CVSS v3)のあるCVE IDを有する脆弱性に絞り込みます。 項目と値は右記のように指定します。[filters][cvss_vector][cvss_v3][項目]=値 (例: q[filters][cvss_vector][cvss_v3][AV]=N) 項目と値の詳細については、こちらをご参照ください。 指定可能な項目と値は下記の通りです。
|
Hash | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][cvss_vector][cvss_v2] |
取得する脆弱性を、指定したCVSS指標(CVSS v2)のあるCVE IDを有する脆弱性に絞り込みます。 項目と値は右記のように指定します。[filters][cvss_vector][cvss_v2][項目]=値 (例: q[filters][cvss_vector][cvss_v2][AV]=N) 項目と値の詳細については、こちらをご参照ください。 指定可能な項目と値は下記の通りです。
|
Hash | なし | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
q[filters][cvss_vector][is_target_unregistered] |
trueを指定すると、取得する脆弱性をCVSS指標が未登録のCVE IDのある脆弱性に絞り込みます。 q[filters][cvss_vector][cvss_v3]またはq[filters][cvss_vector][cvss_v3]と併用して絞り込みすることはできません。 |
Boolean | なし |
レスポンス
key | value の内容 | value の型 |
---|---|---|
success | 認証の成否 | Boolean |
response | エラー等の補足情報 | Hash |
total_size | 取得した脆弱性の数 | Number |
vulnerabilities_by_host | ホストの脆弱性一覧 | Array<Hash> |
html_id | SIDfm ID | String |
title | 脆弱性名 | String |
short_description | 簡易説明 | String |
create_date | 登録日 | String |
update_date | 最終更新日 | String |
url | 脆弱性詳細画面のURL | String |
information_detail_url | 脆弱性情報の詳細画面のURL | String |
warning |
要対応 trueの場合: 要対応 falseの場合: 非要対応 |
Boolean |
status | 対応状況 | String |
sri | SRI | String |
cvss_score | CVSS | String/Null |
area | 影響範囲 | String |
exploitable |
攻撃コードの有無 trueの場合: 有り falseの場合: 無し nullの場合: 出力不可 |
Boolean/Null |
cve_ids | CVE ID | Array<String> |
cvss_v2 | CVE IDの評価(CVSS V2) | Array<Hash> |
id | CVE ID | String |
vector | 評価 | String/Null |
cvss_v3 | CVE IDの評価(CVSS V3) | Array<Hash> |
id | CVE ID | String |
vector | 評価 | String/Null |
elapsed_days | 検出されてからの経過日数 | Number/Null |
created_on | 検出日 | String |
due_date | 対策予定日 | String |
journals | 履歴 | Array<Hash> |
id | 履歴ID | Number |
created_on | 作成日時 | String |
user | ユーザ | Hash |
id | ユーザID | Number |
fullname | 氏名 | String |
mail_address | メールアドレス | String/Null |
notes | コメント | String |
details | 履歴詳細情報 | Hash |
id | 詳細ID | Number |
action | 変更内容 | String |
from | 変更前 | String |
to | 変更後 | String |
affect_packages | 影響するパッケージ | Array<Hash> |
name | ソフトウェア名 | String |
version | バージョン番号 | String |
release | リリース番号 | String/Null |
arch | アーキテクチャ | String/Null |
fullname | パッケージ名 | String |
affect_products | 影響するプロダクト | Array<Hash> |
product_version_id | SIDfmプロダクトのバージョンID | Number/Null |
product_id | SIDfmプロダクトのプロダクトID | Number/Null |
lproduct_version_id | ローカルプロダクトのバージョンID | Number/Null |
sidfmd_lproduct_id | ローカルプロダクトのプロダクトID | Number/Null |
fullname | プロダクト名 | String |
version | バージョン | String |
display_name | 表示名 | String |
ctags | カスタムタグ | Array<Hash> |
id | カスタムタグID | Number |
keyword | カスタムタグ名 | String |
category_id | カテゴリID | Number/Null |
color | 文字色コード | String |
background_color | 背景色コード | String |
priority | 優先度 | Number |
レスポンス例
{ "success": true, "response": {}, "total_size": 3, "vulnerabilities": [ { "html_id": 90000091, "title": "サンプル脆弱性", "short_description": "サンプルの脆弱性", "create_date": "2019/09/03", "update_date": "2019/09/05", "url": "http://example.com/redmine/sidfm/vulnerability/90000091", "information_detail_url": "http://example.com/redmine/sidfm/informations/vuln/90000091", "warning": false, "status": "影響無", "sri": "低", "cvss_score": null, "area": "未定義", "exploitable": null, "cve_ids": [ "CVE-1111-1111" ], "cvss_v2": [ { "id": "CVE-1111-1111", "vector": null } ], "cvss_v3": [ { "id": "CVE-1111-1111", "vector": "AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:H" } ], "elapsed_days": null, "created_on": "2022/01/28", "due_date": "", "journals": [ { "id": 380144, "created_on": "2022/07/02 16:52:14", "user": { "id": 6, "fullname": "SIDfmVM 管理者", "mail_address": "sidfmadm@example.com" }, "notes": "脆弱性情報との照合の結果、脆弱性が無効になったため、ステータスを影響無に変更しました。", "details": [ { "id": 378902, "action": "ステータス変更", "from": "未対策", "to": "影響無" } ] } ], "affect_packages": [ { "name": "libssh2", "version": "1.4.3", "release": "12.el7", "arch": "x86_64", "fullname": "libssh2-1.4.3-12.el7x86_64" } ], "affect_products": [ { "product_version_id": 6522, "product_id": 458, "fullname": "Sophos Anti-Virus for Windows 10.x", "version": "10.x", "display_name": "Sophos Anti-Virus for Windows 10.x" } ], "ctags": [ { "id": 181, "keyword": "タグA", "category_id": null, "color": "#e3e628", "background_color": "#000000", "priority": 5 } ] } ] }
サンプルコード
※ 実際にサンプルコードを試す場合は、色のついている箇所をご自身の環境に合わせて変更しご利用ください。
サンプルコードを試す場合、変更箇所の「http(s)://hostname/redmine」は、システム設定の「メール通知設定用のURL」を、「apikey」は、VM
API キー設定画面で登録済みの API キーを設定する必要があります。