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

Управление конфигурацией

Получить всю конфигурацию

URL: /api/v1/config
Метод: GET
Описание: Возвращает все настройки конфигурации (БД уязвимостей и Telegram-уведомления).

Пример запроса:

GET /api/v1/config HTTP/1.1
Authorization: Bearer <token>

Пример ответа:

{
    "data": {
        "postgres": {
            "vulns_ip": "127.0.0.1",
            "vulns_port": 5432,
            "vulns_login": "postgres",
            "vulns_password": "postgres"
        },
        "telegram": {
            "token": "your-telegram-token",
            "chat_id": [],
            "message_thread_id": [],
            "enabled": false
        }
    }
}

Конфигурация базы уязвимостей

Получить настройки БД

URL: /api/v1/config/database
Метод: GET
Описание: Возвращает настройки подключения к БД уязвимостей.

Пример запроса:

GET /api/v1/config/database HTTP/1.1
Authorization: Bearer <token>

Пример ответа:

{
    "data": {
        "vulns_ip": "127.0.0.1",
        "vulns_port": 5432,
        "vulns_login": "postgres",
        "vulns_password": "postgres"
    }
}

Обновить настройки БД

URL: /api/v1/config/database
Метод: PUT
Описание: Обновить параметры подключения к БД уязвимостей.

JSON Params

Параметр Описание Обязательный
vulns_ip IP-адрес сервера БД Да
vulns_port Порт сервера БД Да
vulns_login Логин пользователя БД Да
vulns_password Пароль пользователя БД Да

Пример запроса:

PUT /api/v1/config/database HTTP/1.1
Authorization: Bearer <token>
{
    "vulns_ip": "192.168.0.10",
    "vulns_port": 5433,
    "vulns_login": "admin",
    "vulns_password": "newpassword"
}

Пример ответа:

{
    "data": {
        "vulns_ip": "192.168.0.10",
        "vulns_port": 5433,
        "vulns_login": "admin",
        "vulns_password": "newpassword"
    }
}

Конфигурация Telegram

Получить настройки Telegram

URL: /api/v1/config/telegram
Метод: GET
Описание: Возвращает текущие настройки Telegram-уведомлений.

Пример запроса:

GET /api/v1/config/telegram HTTP/1.1
Authorization: Bearer <token>

Пример ответа:

{
    "data": {
        "token": "your-telegram-token",
        "chat_id": [],
        "message_thread_id": [],
        "enabled": false
    }
}

Обновить настройки Telegram

URL: /api/v1/config/telegram
Метод: PUT
Описание: Обновить параметры Telegram-уведомлений.

JSON Params

Параметр Описание Обязательный
token Токен Telegram-бота Да
chat_id Список ID чатов Нет
message_thread_id Список ID потоков сообщений Нет
enabled Флаг включения уведомлений Да

Пример запроса:

PUT /api/v1/config/telegram HTTP/1.1
Authorization: Bearer <token>
{
    "token": "new-telegram-token",
    "chat_id": [12345678],
    "message_thread_id": [1111],
    "enabled": true
}

Пример ответа:

{
    "data": {
        "token": "new-telegram-token",
        "chat_id": [12345678],
        "message_thread_id": [1111],
        "enabled": true
    }
}

Сбросить конфигурацию

URL: /api/v1/config/reset
Метод: POST
Описание: Сбрасывает все настройки конфигурации к значениям по умолчанию.

Пример запроса:

POST /api/v1/config/reset HTTP/1.1
Authorization: Bearer <token>

Пример ответа:

{
    "data": {
        "message": "Config successfully reset",
    }
}