REST APIルール
URL api/v1/rulesは、次のHTTP動詞をサポートしています。
POST - 新規ルールを作成します
HTTPリクエスト:
POST api/v1/rules |
リクエストヘッダー:認証トークン
リクエスト本文:新しいルールのXML
応答:201 HTTPコードとHTTPの場所ヘッダーには、新しく作成されたルールのIDを持つGETリクエストのURLが含まれます(たとえば、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 - 1つのルールを取得します
HTTPリクエスト:
GET api/v1/rules/{id} |
URLクエリ:
$idType |
URLの$idType=uuid {id}がルールのUUIDとして解釈される場合 |
リクエストヘッダー:認証トークン
リクエスト本文:なし
応答:応答には、想定されるフィールドに加えて、ルールのXMLを含む"rule"フィールドを追加する必要があります。
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 |
(bool) 値をtrue (1)にして有効化するか、false (0)で無効にします |
リクエストヘッダー:認証トークン
応答本文:なし
特定のルールを有効/無効にします
成功した場合は、204コードを返します
すべてのリクエストは、ヘッダーで認証トークンが必要です。