Создание источника
Запрос
| Тип | Метод |
|---|---|
POST |
/input_sources/create |
Описание: При выполнении запроса будет создан источник с заданными параметрами.
Пример запроса
POST
http://127.0.0.1/cruddy/v2/input_sources/create
Тело запроса:
| Параметр | Тип | Обязательность | Описание |
|---|---|---|---|
| trace_id | string |
Required | Идентификатор для отслеживания цепочки операций и аудита |
| name | string |
Required | Название источника |
| source_type | string |
Required | Тип источника |
| vendor | string |
Required | Вендор |
| port | integer |
Required | Номер источника. Строго 4 цифры |
| is_active | boolean |
Required | Признак, активен ли источник |
| display_name | string |
Required | Составляется из названия и порта |
| check_min | boolean |
Required | Отправлять ли оповещения при достижении порога минимальных поступлений событий: да, нет |
| check_min_value | integer |
Optional | Порог минимальных поступлений, при достижении которых будут отправляться уведомления |
| check_max | boolean |
Required | Отправлять ли оповещения при достижении порога максимальных поступлений событий: да, нет |
| check_max_value | integer |
Optional | Порог максимальных поступлений, при достижении которых будут отправляться уведомления |
| no_raw | boolean |
Required | Опция, не сохранять сырые события для дальнейшей обработки: да, нет |
| input_type | string |
Required | Дополнительная классификация источников внутри платформы. Это могут быть как системы, например, операционные, антивирусные, так и сервисы, так и устройства |
| pipelines | Array<object> |
Optional | Массив связанных правил разбора |
| _relations | object |
Optional | Словарь, описывающий связанные модели через идентификаторы |
Пример тела запроса
{
"trace_id": "df570c03-5a03-4cea-8df0-c162d05127ac",
"name": "string",
"source_type": "string",
"vendor": "string",
"port": 0,
"is_active": true,
"display_name": "string",
"check_min": true,
"check_min_value": 0,
"check_max": true,
"check_max_value": 0,
"no_raw": true,
"input_type": "raw-json",
"pipelines": [
{}
],
"_relations": {}
}
Успешный ответ
Статус код: 201 - успешное создание источника.
Формат: JSON.
Тело ответа: модель созданного источника.
Пример ответа
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created_at": "2025-02-21T11:33:03.241694Z",
"updated_at": "2025-03-27T15:18:23.118238Z",
"trace_id": "df570c03-5a03-4cea-8df0-c162d05127ac",
"name": "string",
"source_type": "string",
"vendor": "string",
"port": 0,
"is_active": true,
"display_name": "string",
"check_min": true,
"check_min_value": 0,
"check_max": true,
"check_max_value": 0,
"no_raw": true,
"input_type": "raw-json",
"pipelines": [
{}
],
"_relations": {}
}
Другие возможные ответы
| Код | Ответ | Описание |
|---|---|---|
400 |
Bad Request |
Неверный тип параметра запроса, либо отсутствует обязательный параметр |
409 |
name_already_used |
Попытка создать объект с существующим уникальным атрибутом |
500 |
Internal Server Error |
Другие ошибки при создании объекта |
Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.
Пример ответа
Код 400
{
"error": "Bad Request",
"error_code": 400
}
Код 409
{
"error": "name_already_used",
"error_code": 409,
"extra": {
"fields": [
"name"
]
}
}
Код 500
{
"error": "Internal Server Error",
"error_code": 500
}