Правила REST API

Скопіювати URL-адресу поточної статті Поділитись електронною поштою

Ця стаття (PDF) Повна документація (PDF)

URL-адреси api/v1/rules підтримують такі HTTP-команди:

POST — створює нове правило

HTTP-запит:

POST api/v1/rules

Заголовок запиту: Маркер авторизації

Тіло запиту: XML нового правила

Реагування: Код HTTP 201 і заголовок HTTP Location містять URL-адресу для запиту GET з ідентифікатором до новоствореного правила (наприклад, HTTP://<<SERVER_NAME>>/api/v1/rules/121, де 121 — ідентифікатор нового правила). Тіло відповіді повертає JSON із новоствореним об’єктом правил. Цей JSON ідентичний відповіді на GET.

Недійсні правила не зберігаються.

GET — виводить правила

HTTP-запит:

GET api/v1/rules

Заголовок запиту: Маркер авторизації

Тіло запиту: Немає

Подібно до API для отримання виявлених об’єктів, GET підтримує $top, $skip, $count і $orderBy у URL-адресі.

Тіло запиту: Немає

Реагування: поля об’єкта JSON: значення й кількість (лише якщо запит має $count). Поле значення містить:

name

enabled

severity

severityScore

GET — отримує окреме правило

HTTP-запит:

GET api/v1/rules/{id}

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила

Заголовок запиту: Маркер авторизації

Тіло запиту: Немає

Реагування: крім очікуваних полів, відповідь має містити поле rule з XML-кодом правила.

PUT — змінює тіло правила

HTTP-запит:

PUT api/v1/rules/{id}

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила

Заголовок запиту: Маркер авторизації

Тіло запиту: Новий XML-код правила.

Реагування: Повертає оновлений об’єкт із запитів. Подібно до POST, повертає відповідь GET.

DELETE — видаляє правило

HTTP-запит:

DELETE api/v1/rules/{id}

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила

Заголовок запиту: Маркер авторизації

Тіло запиту: Немає

Тіло відповіді: Немає

PATCH — оновлює певне правило

HTTP-запит:

PATCH api/v1/rules/{ruleId}

URL-запит:

$idType

якщо $idType=uuid {id} в URL-адресі інтерпретується як uuid правила.

Тіло запиту JSON:

enabled

(bool) значення true (1) для ввімкнення, false (0) для вимкнення

Заголовок запиту: Маркер авторизації

Тіло відповіді: Немає

Вмикає/вимикає певне правило

У разі успіху повертає код 204

У всіх запитах заголовок повинен містити токен авторизації.

˄˅