REST APIの除外
POST - 新しい除外を作成
HTTPリクエスト:
POST api/v1/exclusions |
JSONリクエスト本文:
body |
(文字列) - 新しい除外のXML |
autoResolve |
(bool) - 検出を自動的に解決するかどうか |
name |
(文字列) - 除外の名前。 |
ruleIds |
(配列) - ルールID(文字列としてのUUID)の配列。ruleIdsと同時に使用できます |
ruleUuids |
(配列) - ルールID(整数)の配列。ruleUuidsと同時に使用できます |
note |
(オプション、文字列) - 最大2048文字を格納します |
JSON応答本文:
success |
201 HTTPコードとHTTPの場所。ヘッダーには、新しく作成された除外のIDが含まれたGET要求のURLが含まれます。応答本文は、新しく作成された除外オブジェクトが含まれたJSONを返します。 |
failure |
404 HTTPコードと本文の説明 |
無効な除外はESET Inspect Databaseに保存されません。
GET – 除外を一覧表示します
HTTPリクエスト:
GET api/v1/exclusions |
URLクエリ:
検出を取得するためのAPIと同様に、$top, $skip, $count, $orderByをサポートしています
リクエスト本文:なし
JSON応答本文:値と数(URLクエリに$countが存在する場合のみ)。値フィールドには、次の項目が格納されたオブジェクトの配列が含まれます。
id uuid name enabled note |
GET – 単一の除外を取得します
HTTPリクエスト:
GET api/v1/exclusions/{exclusionId} |
URLクエリ:
$idType |
URLの$idType=uuid {id}がルールのUUIDとして解釈される場合 |
リクエスト本文:なし
JSON応答本文:除外の一覧表示によって返されるフィールドとは別に、応答にはXMLを含む「除外」フィールドが含まれます。
body (xml) id uuid name enabled note ruleIds (整数) ruleUuids (文字列としてのUUID) |
PUT – 除外本文を編集します
HTTPリクエスト:
PUT api/v1/exclusions/{exclusionId} |
URLクエリ:
$idType |
URLの$idType=uuid {id}がルールのUUIDとして解釈される場合 |
JSONリクエスト本文:POST新しい除外の場合と同じです。
JSON応答本文:リクエストから更新されたオブジェクトを返します。POSTと同様に、GET応答を返します。
DELETE – 除外を削除します
HTTPリクエスト:
DELETE api/v1/exclusions/{exclusionId} |
URLクエリ:
$idType |
URLの$idType=uuid {id}がルールのUUIDとして解釈される場合。 |
リクエスト本文: なし
応答本文: なし
GET – ルールに関連付けられた除外を取得します
HTTPリクエスト:
GET api/v1/exclusions/rule/{ruleId} |
URLクエリ:
$idType |
URLの$idType=uuid {id}がルールのUUIDとして解釈される場合 |
リクエスト本文:なし
JSON応答本文:GETと同じ – 除外を一覧表示します。ルールに関連付けられた除外の配列を返します。
例:
https://192.168.197.200/api/v1/executables/066F8964A44161825BE6F4E10B05CD66F3C115FC/block?$idType=sha1はhttps://192.168.197.200/api/v1/executables/1605/blockと等しくなります(ID = sha1またはデータベース内のモジュールのID) |