Управление правилами трафика

API правил трафика Ideco Center описано в статье Центральная консоль.

Длина комментариев (comment) при API-запросах ограничена 255 символами.

Файрвол

Получение статуса службы

GET /firewall/status

Ответ на успешный запрос:

[
  {
      "name": "rules-in-kernel",
      "status": "active|activating|deactivating|failed|inactive|reloading",
      "msg": [ "string" ]  //(Список строк, поясняющих текущее состояние)
  },
  {
        "msg": [ "string" ],
        "status": "active",
        "name": "auto-snat"
    }
]

Получение настроек Файрвола

Включенность пользовательских правил

GET /firewall/state

Ответ на успешный запрос:

{
    "enabled": "boolean"
}

enabled - Опция раздела Файрвол включен (true) или отключен (false).

Логирование правил

GET /firewall/settings

Ответ на успешный запрос:

{
    "automatic_snat_enabled": "boolean",
    "log_mode": "nothing" | "all" | "selected",
    "log_actions": ["accept" | "drop" | "dnat" | "snat" | "mark_log" | "mark_not_log"],
}

Изменение настроек

PUT /firewall/settings

Json-тело запроса:

{
    "automatic_snat_enabled": "boolean",
    "log_mode": "nothing" | "all" | "selected",
    "log_actions": ["accept" | "drop" | "dnat" | "snat" | "mark_log" | "mark_not_log"],
}

automatic_snat_enabled - включение автоматического SNAT;
log_mode - режим логирования;
log_actions - события, которые будут логироваться.

Ответ на успешный запрос: 200 ОК

Управление правилами

Получение списка правил

GET /firewall/rules/forward - раздел FORWARD;
GET /firewall/rules/input - раздел INPUT;
GET /firewall/rules/dnat - раздел DNAT;
GET /firewall/rules/snat - раздел SNAT;
GET /firewall/rules/log - раздел Логирование.

Ответ на успешный запрос:

[
    {
        "action": "accept" | "drop" | "dnat" | "snat" ("mark_log" | "mark_not_log" для раздела Логирование),
        "comment": "string",
        "destination_addresses": [ "string" ], 
        "destination_addresses_negate": "boolean",
        "destination_ports": [ "string" ],
        "enabled": "boolean",
        "hip_profiles": [ "string" ],
        "incoming_interface": "string",
        "outgoing_interface": "string",
        "parent_id": "string",
        "protocol": "string",
        "source_addresses": [ "string" ],
        "source_addresses_negate": "boolean",
        "timetable": [ "string" ],
        "id": "integer"
    },
    ...
]

"action" - действие:
- "accept" - разрешить;
- "drop" - запретить;
- "dnat" - производить DNAT;
- "snat" - производить SNAT;
- "mark_log" - логировать;
- "mark_not_log" - не логировать;
"comment" - комментарий (может быть пустым);
"destination_addresses" - адрес назначения;
"destination_addresses_negate" - инвертировать адрес назначения;
"destination_ports" - порты назначения;
"enabled" - включено (true) или выключено (false) правило;
"hip_profiles" - HIP-профили;
"incoming_interface" - зона источника;
"outgoing_interface" - зона назначения;
"parent_id" - идентификатор группы в Ideco Center, в которую входит сервер, или константа "f3ffde22-a562-4f43-ac04-c40fcec6a88c" (соответствует Корневой группе);
"protocol" - протокол;
"source_addresses" - адрес источника;
"source_addresses_negate" - инвертировать адрес источника;
"timetable" - время действия;
"id" - идентификатор правила.

Добавление правила

POST /firewall/rules/forward?anchor_item_id=123&insert_after={true|false} - раздел FORWARD;
POST /firewall/rules/input?anchor_item_id=123&insert_after={true|false} - раздел INPUT;
POST /firewall/rules/dnat?anchor_item_id=123&insert_after={true|false} - раздел DNAT;
POST /firewall/rules/snat?anchor_item_id=123&insert_after={true|false} - раздел SNAT;
POST /firewall/rules/log?anchor_item_id=123&insert_after={true|false} - раздел Логирование.
- anchor_item_id - идентификатор правила, ниже или выше которого нужно создать новое. Если отсутствует, то новое правило будет добавлено в конец таблицы.
- insert_after - вставка до или после. Если значение true или отсутствует, то новое правило будет добавлено сразу после указанного в anchor_item_id. Если false - на месте указанного в anchor_item_id.

Json-тело запроса:

{
    "action": "accept" | "drop" | "dnat" | "snat" ("mark_log" | "mark_not_log" для раздела Логирование),
    "comment": "",
    "destination_addresses": [ "string" ],
    "destination_addresses_negate": "boolean",
    "destination_ports": [ "string" ],
    "enabled": "boolean",
    "hip_profiles": [ "string" ],
    "incoming_interface": "string",
    "outgoing_interface": "string",
    "parent_id": "string",
    "protocol": "string",
    "source_addresses": [ "string" ],
    "source_addresses_negate": "boolean",
    "timetable": [ "string" ]
    }

Ответ на успешный запрос:

{
    "id": "integer"
}

Редактирование правила

PUT /firewall/rules/forward/<id правила> - раздел FORWARD;
PUT /firewall/rules/input/<id правила> - раздел INPUT;`
PUT /firewall/rules/dnat/<id правила> - раздел DNAT;
PUT /firewall/rules/snat/<id правила> - раздел SNAT;
PUT /firewall/rules/log/<id правила> - раздел Логирование.

Json-тело запроса:

{
    "action": "accept" | "drop" | "dnat" | "snat" ("mark_log" | "mark_not_log" для раздела Логирование),
    "comment": "",
    "destination_addresses": [ "string" ],
    "destination_addresses_negate": "boolean",
    "destination_ports": [ "string" ],
    "enabled": "boolean",
    "hip_profiles": [ "string" ],
    "incoming_interface": "string",
    "outgoing_interface": "string",
    "parent_id": "string",
    "protocol": "string",
    "source_addresses": [ "string" ],
    "source_addresses_negate": "boolean",
    "timetable": [ "string" ]
    }

Ответ на успешный запрос: 200 ОК

Перемещение правила

PATCH /firewall/rules/forward/move - раздел FORWARD;
PATCH /firewall/rules/input/move - раздел INPUT;
PATCH /firewall/rules/dnat/move - раздел DNAT;
PATCH /firewall/rules/snat/move - раздел SNAT;
PATCH /firewall/rules/log/move - раздел Логирование.

Json-тело запроса:

{
  "params": {
    "id": "integer",
    "anchor_item_id": "integer",
    "insert_after": "boolean"
  }
}

id - идентификатор перемещаемого правила;
anchor_item_id - идентификатор правила, ниже или выше которого нужно поместить перемещаемое правило;
insert_after - вставка до или после. Если true, то вставить правило сразу после указанного в anchor_item_id, если false - на месте указанного в anchor_item_id.

Удаление правила

DELETE /firewall/rules/forward/<id правила> - раздел FORWARD;
DELETE /firewall/rules/input/<id правила> - раздел INPUT;
DELETE /firewall/rules/dnat/<id правила> - раздел DNAT;
DELETE /firewall/rules/snat/<id правила> - раздел SNAT;
DELETE /firewall/rules/log/<id правила> - раздел Логирование.

Ответ на успешный запрос: 200 ОК

Счетчик срабатывания правил

Узнать, включен ли счетчик срабатываний правил

GET /firewall/watch

Ответ на успешный запрос:

{
   "enabled": "boolean" //(true - если счетчик включен, false - если выключен)
}

Включение/выключение счетчика срабатывания правил

PUT /firewall/watch

Json-тело запроса:

{
   "enabled": "boolean" //(true - чтобы включить, false - чтобы выключить)
}

Ответ на успешный запрос: 200 ОК

Получение счетчиков по правилам

GET /firewall/counters/forward - раздел FORWARD;
GET /firewall/counters/input - раздел INPUT;
GET /firewall/counters/dnat - раздел DNAT;
GET /firewall/counters/snat - раздел SNAT;
GET /firewall/rules/log - раздел Логирование.

Ответ на успешный запрос:

[
   {
      "id": "integer",
      "packets": "integer" //(количество сработок правила)
   },
   ...
]

Контроль приложений

Получение списка всех правил

GET /application_control_backend/rules

Ответ на успешный запрос:

[
{
        "action": "string", // ["drop"|"accept"]
        "aliases": ["string"],
        "comment": "string",
        "enabled": "boolean",
        "name": "string",
        "parent_id": "string",
        "protocols": ["string"],
        "id": "integer"
}
]

action - действие, применяемое к правилу;
aliases - алиасы, которые используются в правиле (например, any);
comment - комментарий правила;
enabled - статус правила (true - включено, false - отключено);
name - имя правила;
parent_id - идентификатор родительской группы серверов;
protocols - список протоколов;
id - уникальный номер правила.

Создание нового правила

POST /application_control_backend/rules

Json-тело запроса:

{
"parent_id": "string",
"name": "string",
"action": "string", // ["drop"|"accept"],
"comment": "string",
"aliases":["string"],
"protocols":["string"],
"enabled": "boolean"
}

action - действие, применяемое к правилу;
aliases - алиасы, которые используются в правиле (например, any);
comment - комментарий правила;
enabled - статус правила (true - включено, false - отключено);
name - имя правила;
parent_id - идентификатор родительской группы серверов;
protocols - список протоколов;

Ответ на успешный запрос:

{
    "id": "integer"
}

id - уникальный номер созданного правила.

Изменение правила

PUT /application_control_backend/rules/{id}

id - уникальный номер правила;

Json-тело запроса:

{
    "parent_id": "str",
    "name": "str",
    "comment": "str",
    "aliases": ["str"],
    "protocols": ["str"],
    "action": "string", // ["drop"|"accept"],
    "enabled": "boolean",
}

action - действие, применяемое к правилу;
aliases - алиасы, которые используются в правиле (например, any);
comment - комментарий правила;
enabled - статус правила (true - включено, false - отключено);
name - имя правила;
parent_id - идентификатор родительской группы серверов;
protocols - список протоколов;

Ответ на успешный запрос: 200 ОК

Изменение приоритета правила

PATCH /application_control_backend/rules/move

Json-тело запроса:

{
  "params": {
    "id": "integer",
    "anchor_item_id": "integer",
    "insert_after": "boolean",
  },
}

id - уникальный идентификатор правила;
anchor_item_id - уникальный идентификатор правила, ниже или выше которого нужно создать новое;
insert_after - вставка до или после. Если True, то вставить правило сразу после указанного в anchor_item_id, если False, то на месте указанного в anchor_item_id.

Удаление правила

DELETE /application_control_backend/rules/{id}

id - уникальный номер правила, которое нужно удалить.

Ответ на успешный запрос: 200 OK

Предотвращение вторжений

Получение статуса модуля

`GET /ips/status`

Ответ на успешный запрос:

[
    {
        "name": "string",
        "status": "string", // ["active"|"activating"|"deactivating"|"failed"|"inactive"|"reloading"],
        "msg": ["str"]
    }
]

name - название демона;
status - статус;
msg - cписок сообщений, объясняющий текущее состояние.

Статус обновления баз правил сурикаты и GeoIP

GET /ips/update

Ответ на успешный запрос:

{
    "status": "string", // ["up_to_date|updating|failed_to_update|disabled"]
    "msg": "i18n_str",
    "last_update": "float|null"
}

status - текущий статус обновления баз:
- up_to_date - базы успешно обновлены;
- updating - скачиваем новые базы;
- failed_to_update - последняя попытка обновления баз завершилась неудачно;
- disabled - обновление баз выключено.
msg - текстовое описание статуса обновления баз, переведённое на бэкенде;
last_update - время (таймстамп) последнего успешного обновления баз.

Статус обновления расширенных баз правил сурикаты и GeoIP

GET /ips/update_advanced

Ответ на успешный запрос:

{
    "status": "string", //["up_to_date"|"updating"|"failed_to_update"|"disabled"],
    "msg": "i18n_str",
    "last_update": "float|null"
}

status - текущий статус обновления баз:
- up_to_date - базы успешно обновлены;
- updating - скачиваем новые базы;
- failed_to_update - последняя попытка обновления баз завершилась неудачно;
- disabled - обновление баз выключено.
msg - текстовое описание статуса обновления баз, переведённое на бэкенде;
last_update - время (таймстамп) последнего успешного обновления баз.

Запуск принудительного обновления баз

POST /ips/update

Тело запроса пустое.

Ответ на успешный запрос: 200 OK

Получение текущей настройки включенности модуля

GET /ips/state

Ответ на успешный запрос:

{
    "enabled": "boolean"
}

enabled - true если модуль включен, false - если выключен

Изменение настройки включенности модуля

PUT /ips/state

Json-тело запроса:

{
    "enabled": "boolean"
}

enabled - true если модуль включен, false - если выключен

Ответ на успешный запрос: 200 OK

Получение списка локальных подсетей

GET /ips/nets

Ответ на успешный запрос:

[
  {
    "id": "string",
    "address": "string"
  }
]

id - уникальный идентификатор подсети;
address - подсеть (например "192.168.0.0/16").

Добавление новой локальной подсети

POST /ips/nets

Json-тело запроса:

{
    "address": "string"
}

address - подсеть (например "192.168.0.0/16").

Ответ на успешный запрос:

{
    "id": "string",
    "address": "string"
}

id - уникальный идентификатор подсети;
address - подсеть (например "192.168.0.0/16").

Удаление локальной подсети

DELETE /ips/nets/{id}

id - уникальный идентификатор подсети

Ответ на успешный запрос: 200 OK

Получение списка наборов правил

GET /ips/rules

[
  {
    "id": "string",
    "name": "string",
    "enabled": "bool"
  },
  ...
]

id - уникальный идентификатор набора правил;
name - название (имя файла) набора правил;
enabled - состояние набора правил: включен/выключен.

Включение/выключение набора правил

PATCH /ips/rules/{id}

id - уникальный идентификатор набора правил

Json-тело запроса:

{
    "enabled": "boolean"
}

Ответ на успешный запрос: 200 OK

Получение содержимого правила по sid

GET /ips/rules/sid/{id}

id - sid правила

Ответ на успешный запрос:

{
    "rule": "string"
}

rule - текст правила. Если правило не найдено - пустая строка.

Получение списка всех исключений

GET /ips/disabled_rules

Ответ на успешный запрос:

[
    {
    "sid": "integer",
    "comment": "string",
    "id": "string"
    }
]

sid - уникальный идентификатор правила;
comment - описание, может быть пустым, максимальная длина 256;
id - уникальный идентификатор правила на NGFW.

Добавление исключения

POST /ips/disabled_rules

Json-тело запроса:

{
    "sid": "int",
    "comment": "string"
}

sid - уникальный идентификатор правила;
comment - описание, может быть пустым, максимальная длина 256;

Ответ на успешный запрос:

{
  "id": "string" 
}

Редактирование описания существующего исключения

PATCH /ips/disabled_rules/{id}

id - уникальный идентификатор правила (не sid).

Json-тело запроса:

{
    "sid": "int",
    "comment": "string"
}

sid - уникальный идентификатор правила;
comment - описание, может быть пустым, максимальная длина 256;

Ответ на успешный запрос: 200 OK

Удаление существующего исключения

DELETE /ips/disabled_rules/{id}

id - уникальный идентификатор правила (не sid).

Ответ на успешный запрос: 200 OK

Получение списка исключений алиасов

GET /ips/bypass

Ответ на успешный запрос:

[
    {
        "id": "string",
        "aliases": [ "string" ],
        "comment": "string",
        "enabled": "boolean",
    }
]

id - id исключения;
aliases - список id алиасов. Допустимые типы: IP-адрес, Диапазон IP-адресов, Список IP-объектов, Список IP-адресов, Подсеть, Домен, Пользователь, Группа;
comment - описание, может быть пустым, максимальная длина 256;
enabled - состояние исключения: включено/выключено.

Добавление исключения алиасов

POST /ips/bypass

Json-тело запроса:

{
    "aliases": [ "string" ],
    "comment": "string",
    "enabled": "bool",
}

aliases - список id алиасов. Допустимые типы: IP-адрес, Диапазон IP-адресов, Список IP-объектов, Список IP-адресов, Подсеть, Домен, Пользователь, Группа;
comment - описание, может быть пустым, максимальная длина 256;
enabled - состояние исключения: включено/выключено.

Ответ на успешный запрос:

{
    "id": "string"
}

id - уникальный идентификатор созданного исключения.

Изменение исключения алиасов

PATCH /ips/bypass/{id}

id - уникальный идентификатор созданного исключения.

Json-тело запроса:

{
    "aliases": [ "string" ],
    "comment": "string",
    "enabled": "bool",
}

aliases - список id алиасов. Допустимые типы: IP-адрес, Диапазон IP-адресов, Список IP-объектов, Список IP-адресов, Подсеть, Домен, Пользователь, Группа;
comment - описание, может быть пустым, максимальная длина 256;
enabled - состояние исключения: включено/выключено.

Ответ на успешный запрос: 200 OK

Удаление существующего исключения алиасов

DELETE /ips/bypass/{id}

id - уникальный идентификатор исключения.

Ответ на успешный запрос: 200 OK

Контент-фильтр

Включение/выключение Контент-фильтра

Проверить включенность

GET /content-filter/state

Ответ на успешный запрос:

{
    "enabled": "boolean"
}

Включить/выключить Контент-фильтр

PUT /content-filter/state

Json-тело запроса:

{
    "enabled": "boolean"
}

Ответ на успешный запрос: 200 ОК

Настройки

Получение настроек

GET /content-filter/settings

Ответ на успешный запрос:

{
    "enabled_extended_categorizer": "boolean",
    "quic_reject_enabled": "boolean"
}

enabled_extended_categorizer - расширенная категоризация (SkyDNS) включена (true) или выключена (false);
quic_reject_enabled - запрет трафика по протоколу QUIC включен (true) или выключен (false).

Изменение настроек

PATCH /content-filter/settings

Json-тело запроса:

{
    "enabled_extended_categorizer": "boolean",
    "quic_reject_enabled": "boolean" //(Любое из полей может отсутствовать)
}

Ответ на успешный запрос: 200 OK

Получение настройки безопасного поиска

GET /proxy_backend/safe_search

Ответ на успешный запрос:

{
    "enabled": "boolean"
}

Изменение настройки безопасного поиска

PUT /proxy_backend/safe_search

Json-тело запроса:

{
    "enabled": "boolean"
}

Ответ на успешный запрос: 200 OK

Категории Контент-фильтра

Получение списка категорий (предустановленных и пользовательских)

GET /content-filter/categories

Json-тело ответа:

[
    {
        "id": "string",
        "type": "string",
        "name": "string",
        "comment": "string"
    },
    ...
]

id - номер категории в формате users.id.1 или extended.id.1.
type - тип категории:
- "users" - пользовательские категории;
- "extended" - расширенные категории (SkyDNS);
- "files" - категории для файлов;
- "special" - специальные предопределенные категории:
  - Прямое обращение по IP;
  - Все категоризированные запросы;
  - Все некатегоризированные запросы;
  - Все запросы (категоризированные и некатегоризированные).
- "other" - остальные категории.
name - имя категории (для отображения пользователю).
comment - описание категории (для отображения пользователю).

Получение списка пользовательских категорий

GET /content-filter/users_categories

Json-ответ на запрос:

[
    {
        "id": "string" (номер категории, вида - users.id.1),
        "name": "string" (название категории, не пустая строка),
        "comment": "string",
        "urls": ["string"]
    },
    ...
]

"urls" - список url. Либо полный путь до страницы, либо только доменное имя. В пути может присутствовать любое количество любых символов.

Создание пользовательской категории

POST /content-filter/users_categories

Json-тело запроса:

{
    "name": "string",
    "comment": "string",
    "urls": [ "string" ]
}

Ответ на успешный запрос:

{
    "id": "string"
}

Редактирование пользовательских категорий

PUT /content-filter/users_categories/{category_id}

Json-тело запроса:

{
    "name": "string",
    "comment": "string",
    "urls": ["string"]
}

Ответ на успешный запрос:

{
    "id": "string",
    "name": "string",
    "comment": "string",
    "urls": [ "string" ]
}

Правила Контент-фильтра

Получение списка правил

GET /content-filter/rules

Json-тело ответа:

[
    {
        "access": "allow" | "deny" | "bump" | "redirect",
        "aliases": ["string"],
        "categories": ["string"],
        "comment": "string",
        "enabled": "boolean",
        "name": "string",
        "parent_id": "string",
        "redirect_url": "string" | "null",
        "timetable": ["string"],
        "id": "integer"
    },
    ...
]

id - идентификатор правила;
parent_id - id группы в Ideco Center, в которую входит Ideco NGFW, или константа "f3ffde22-a562-4f43-ac04-c40fcec6a88c" (соответствует Корневой группе);
name - название правила, не пустая строка;
comment - комментарий (макс. 256 символов), может быть пустым;
aliases - список id алиасов (поле Применяется для);
categories - список id категорий сайтов;
access - действие, которое необходимо выполнить в правиле, строка, может принимать три значения:
- allow - разрешить данный запрос;
- deny - запретить запрос и показать страницу блокировки;
- bump: расшифровать запрос;
- redirect: перенаправить запрос на redirect_url;
redirect_url - URL, на который перенаправляются запросы. String при access = redirect и null при остальных вариантах access;
enabled: правило включено (true) или выключено (false);
timetable - время действия, список ID алиасов.

Создание правила

POST /content-filter/rules?anchor_item_id=123&insert_after={true|false}

anchor_item_id - идентификатор правила, ниже или выше которого нужно создать новое. Если отсутствует, то новое правило будет добавлено в конец таблицы.
insert_after - вставка до или после. Если значение true или отсутствует, то новое правило будет добавлено сразу после указанного в anchor_item_id. Если false - на месте указанного в anchor_item_id.

Json-тело запроса:

{
    "name": "string",
    "comment": "string",
    "parent_id": "string", 
    "aliases": [ "string" ],
    "categories": [ "string" ],
    "access": "allow|deny|bump|redirect",
    "redirect_url": "string|null",
    "enabled": "boolean",
    "timetable": [ "string" ]
}

Редактирование правила

PUT /content-filter/rules/<id правила>

Json-тело запроса:

{
    "name": "string",
    "comment": "string",
    "parent_id": "string", 
    "aliases": [ "string" ],
    "categories": [ "string" ],
    "access": "allow|deny|bump|redirect",
    "redirect_url": "string|null",
    "enabled": "boolean",
    "timetable": [ "string" ]
}

Ответ на успешный запрос: 200 ОК

Перемещение правила

PATCH /content-filter/rules/move

Json-тело запроса:

{
  "params": {
    "id": "integer",
    "anchor_item_id": "integer",
    "insert_after": "boolean"
  }
}

id - идентификатор правила;
anchor_item_id - идентификатор правила, ниже или выше которого нужно вставить правило, которое перемещаем;
insert_after - вставка до или после. Если true, то правило будет вставлено сразу после указанного в anchor_item_id, если false - на месте указанного в anchor_item_id.

Ответ на успешный запрос: 200 OK

Удаление правила

DELETE /content-filter/rules/<id правила>

Ответ на успешный запрос: 200 ОК

Квоты

Проверить, включен ли подсчет квот

GET /quotas/state

Ответ на успешный запрос:

{
  "enabled": "boolean"
}

Включить/выключить подсчет квот

PUT /quotas/state

Json-тело запроса:

{
  "enabled": "boolean"
}

Ответ на успешный запрос: 200 ОК

Получение списка квот

GET /quotas/quotas

Ответ на успешный запрос:

[
  {
    "id": "string",
    "title": "string",
    "comment": "string",
    "quota": "integer",
    "enabled": "bool",
    "interval": "hour" | "day" | "week" | "month" | "quarter"
  },
  ...
]

id - идентификатор квоты;
title - название квоты (максимальная длина 42 символа);
comment - комментарий (максимальная длина 256 символов)%
quota - ограничение трафика в байтах;
enabled - применяется ли квота;
interval - период действия квоты (час, день, неделя, месяц, квартал).

Создание квоты

POST /quotas/quotas

Json-тело запроса:

{
  "title": "string",
  "comment": "string",
  "quota": "integer",
  "enabled": "boolean",
  "interval": "string"
}

Ответ на успешный запрос:

{
    "id": "string"
}

Редактирование квоты

PATCH /quotas/quotas/<id квоты>

Json-тело запроса (все или некоторые поля):

{
  "title": "string",
  "comment": "string",
  "quota": "integer",
  "enabled": "boolean",
  "interval": "string"
}

Ответ на успешный запрос: 200 ОК

Удаление квоты

DELETE /quotas/quotas/<id квоты>

Ответ на успешный запрос: 200 ОК

PreviousУправление Ideco Client NextУправление сетевыми интерфейсами

Last updated 20 days ago