REST API 规则
URL api/v1/rules 支持以下 HTTP 谓词:
POST - 创建新规则
HTTP 请求:
POST api/v1/rules |
请求标头:授权标记
请求正文:新规则的 XML
响应:201 HTTP 代码和 HTTP 位置标头包含的 GET 请求的 URL 具有新创建规则的 ID(例如,HTTP://<<SERVER_NAME>>/api/v1/rules/121,其中 121 是新规则的 ID)。响应正文返回具有新创建的规则对象的 JSON。此 JSON 与对 GET 的响应相同。
不会保存无效规则。
GET - 列出规则
HTTP 请求:
GET api/v1/rules |
请求标头:授权标记
请求正文:无
类似于用于获取检测的 API,GET 支持在 URL 中使用 $top、$skip、$count 和 $orderBy。
请求正文:无
响应:JSON 对象字段:值和计数(仅当查询中存在 $count 时)。值字段包含:
id name enabled severity severityScore |
GET - 获取单个规则
HTTP 请求:
GET api/v1/rules/{id} |
URL 查询:
$idType |
URL 中的 $idType=uuid {id} 是否被解释为规则的 uuid |
请求标头:授权标记
请求正文:无
响应:除预期字段之外,响应还应包含带有规则 XML 的“规则”字段。
PUT - 编辑规则正文
HTTP 请求:
PUT api/v1/rules/{id} |
URL 查询:
$idType |
URL 中的 $idType=uuid {id} 是否被解释为规则的 uuid |
请求标头:授权标记
请求正文:规则的新 XML。
响应:从请求返回更新的对象。与 POST 类似,返回 GET 响应。
DELETE - 删除规则
HTTP 请求:
DELETE api/v1/rules/{id} |
URL 查询:
$idType |
URL 中的 $idType=uuid {id} 是否被解释为规则的 uuid |
请求标头:授权标记
请求正文:无
响应正文:无
PATCH - 更新特定规则
HTTP 请求:
PATCH api/v1/rules/{ruleId} |
URL 查询:
$idType |
URL 中的 $idType=uuid {id} 是否被解释为规则的 uuid。 |
JSON 请求正文:
enabled |
(布尔)值,true (1) 表示启用,false (0) 表示禁用 |
请求标头:授权标记
响应正文:无
启用/禁用特定规则
如果成功,则返回 204 代码
所有请求都需要标头中的授权标记。