REST API 排除
POST – 创建新的排除
HTTP 请求:
POST api/v1/exclusions |
JSON 请求正文:
body |
(字符串)- 新排除的 XML |
autoResolve |
(布尔)- 是否自动解析检测 |
name |
(字符串)- 排除的名称。 |
ruleIds |
(数组)- 规则 ID 数组(字符串形式的 uuid);可与 ruleIds 同时使用 |
ruleUuids |
(数组)- 规则 ID 数组(整数);可与 ruleUuids 同时使用 |
note |
(可选,字符串)- 最多可存储 2048 个字符 |
JSON 响应正文:
success |
201 HTTP 代码和 HTTP 位置。标头包含用于 GET 请求的 URL,并附有新创建的排除的 ID。响应正文返回具有新创建的排除对象的 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) |