Перейти к содержанию

Обзор

Основные характеристики

Характеристика Значение
Наименование findings
Компоненты Cruddy
Появился в версии 3.7.0
Доступен в версиях 3.7.0 и выше
Авторизация по токену Security scheme type: http
Bearer format: JWT
Авторизация по APIkey Security scheme type: apiKey
Header parameter name: PgrApiKey
Версия API v2

Описание: Ресурс findings отвечает за управление типами инцидентов. Типы инцидентов содержат сведения об угрозах, на основе которых создаются инциденты. В платформе каждый инцидент всегда принадлежит к определенному типу инцидента.

Список методов для работы с ресурсом

Тип Метод Описание
POST /findings/create Создание типа инцидента
PUT /findings/update Обновление информации о типе инцидента
POST /findings/search Поиск типов инцидентов
GET /findings/{id} Получение типа инцидента по ID
DELETE /findings/{id} Удаление типа инцидента
POST /findings/group Группировка типов инцидентов
POST /findings/mass_delete Массовое удаление типов инцидента
DELETE /findings/all Удаление всех типов инцидента
GET /findings/_meta Получение свойств типов инцидента и действий пользователей

Ответы методов

Статус код Описание
200 Успех
201 Успешное создание объекта
204 Успешный ответ. Пустое тело ответа
400 Неверный тип параметра запроса, либо отсутствует обязательный параметр
404 Ресурс не найден
409 Попытка присвоить объекту существующее уникальное значение атрибута
500 Ошибка сервера

Модели объектов

Название Описание
Finding Модель данных ресурса findings