DNS-сервер

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

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

GET /dns/status

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

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

• name - название службы;

• status - состояние службы;

• msg - список ошибок, может быть пустым.

Настройки

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

GET /dns/settings

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

{
	"intercept_enabled": "boolean"
}

• intercept_enabled - перехватывать DNS-запросы на серверы в интернет.

Включение/выключение DNS-сервера

PATCH /dns/settings

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

{
    "intercept_enabled": "boolean"
}

• intercept_enabled - перехватывать DNS-запросы на серверы в интернет.

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

Включение/выключение переадресации DNS для безопасного поиска

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

GET /dns/safesearch

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

{
	"enabled": "boolean"
}

• enabled - переадресовывать DNS-запросы на безопасные домены поиска Google, Yandex, YouTube, Bing, DuckDuckGo, Qwant и Pixabay.

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

PATCH /dns/safesearch

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

{
    "enabled": "boolean"
}

• enabled - переадресовывать DNS-запросы на безопасные домены поиска Google, Yandex, YouTube, Bing, DuckDuckGo, Qwant и Pixabay.

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

Управление внешними DNS-серверами

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

GET /dns/zones/root

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

[
    {
    "id": "string",
    "enabled": "boolean",
    "type": "ip" | "interface",
    "object": "string",
    "comment": "string"
},
...
]

• id - идентификатор объекта;

• enabled - если true, то элемент включен, false - выключен;

• type - принимает два значения:

  • ip - IP-адрес DNS-сервера, заданного вручную;

  • interface - идентификатор алиаса подключения к провайдеру (DNS-серверы, выданные подключению). Тип алиаса - isp.

• object - IP-адрес, если тип ip, или идентификатор алиаса подключения к провайдеру, если тип interface;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

Добавление корневого DNS-сервера

POST /dns/zones/root

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

{
    "enabled": "boolean",
    "type": "ip" | "interface",
    "object": "string",
    "comment": "string"
}

• enabled - если true, то элемент включен, false - выключен;

• type - принимает два значения:

  • ip - IP-адрес DNS-сервера, заданного вручную;

  • interface - идентификатор алиаса подключения к провайдеру (DNS-серверы, выданные подключению). Тип алиаса - isp.

• object - IP-адрес, если тип ip, или идентификатор алиаса подключения к провайдеру, если тип interface;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

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

{
    "id": "string"
}

• id - идентификатор DNS-сервера.

Редактирование корневого DNS-сервера

PATCH /dns/zones/root/<id DNS-сервера>

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

{
    "enabled": "boolean",
    "type": "ip" | "interface",
    "object": "string",
    "comment": "string"
}

• enabled - если true, то элемент включен, false - выключен;

• type - принимает два значения:

  • ip - IP-адрес DNS-сервера, заданного вручную;

  • interface - идентификатор алиаса подключения к провайдеру (DNS-серверы, выданные подключению). Тип алиаса - isp.

• object - IP-адрес, если тип ip, или идентификатор алиаса подключения к провайдеру, если тип interface;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

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

Удаление корневого DNS-сервера

DELETE /dns/zones/root/<id DNS-сервера>

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

Управление Forward-зонами

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

GET /dns/zones/forward

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

[
    {
    "id": "string",
    "name": "string",
    "enabled": "boolean",
    "servers": [ "string" ],
    "comment": "string",
},
    ...
]

• id - идентификатор объекта;

• name - название зоны;

• enabled - если true, то зона включена, false - выключена;

• servers - список IP-адресов DNS-серверов, заданных вручную;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

Добавление Forward-зоны

POST /dns/zones/forward

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

{
    "name": "string",
    "enabled": "boolean",
    "servers": [ "string" ],
    "comment": "string"
}

• name - название зоны;

• enabled - если true, то зона включена, false - выключена;

• servers - список IP-адресов DNS-серверов, заданных вручную;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

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

{
    "id": "string"
}

• id - идентификатор Forward-зоны.

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

PATCH /dns/zones/forward/<id Forward-зоны>

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

{
    "name": "string",
    "enabled": "boolean",
    "servers": [ "string" ],
    "comment": "string"
}

• name - название зоны;

• enabled - если true, то зона включена, false - выключена;

• servers - список IP-адресов DNS-серверов, заданных вручную;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

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

Удаление Forward-зоны

DELETE /dns/zones/forward/<id Forward-зоны>

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

Управление Master-зонами

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

GET /dns/zones/master

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

[
    {
    "id": "string",
    "name": "string",
    "enabled": "boolean",
    "config": "string",
    "comment": "string",
},
    ...
]

• id - идентификатор объекта;

• name - уникальное название зоны, имеет вид домена example.com;

• enabled - если true, то зона включена, false - выключена;

• config - текст с параметрами зоны, не может быть пустым. Максимальная длина - 10000 символов;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

Подробнее о формате записей для настройки Master-зоны - в статье Master-зоны.

Добавление Master-зоны

POST /dns/zones/master

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

{
    "name": "string",
    "enabled": "boolean",
    "config": "string",
    "comment": "string",
}

• name - уникальное название зоны, имеет вид домена example.com;

• enabled - если true, то зона включена, false - выключена;

• config - текст с параметрами зоны, не может быть пустым. Максимальная длина - 10000 символов;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

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

{
    "id": "string"
}

• id - идентификатор Master-зоны.

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

PATCH /dns/zones/master/<id Master-зоны>

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

{
    "name": "string",
    "enabled": "boolean",
    "config": "string",
    "comment": "string",
}

• name - уникальное название зоны, имеет вид домена example.com;

• enabled - если true, то зона включена, false - выключена;

• config - текст с параметрами зоны, не может быть пустым. Максимальная длина - 10000 символов;

• comment - комментарий, может быть пустым, максимальная длина - 255 символов.

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

Удаление Master-зоны

DELETE /dns/zones/master/<id Master-зоны>

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

DDNS

DDNS в Ideco NGFW реализован через интеграцию с хостингом RU-CENTER. Перед настройкой DDNS зарегистрируйтесь на сайте RU-CENTER и приобретите DNS-хостинг.

Подробнее о DDNS - в статье.

Получение состояния

GET /dns/ddns/state

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

{
    "enabled": "boolean"
}

• enabled - состояние DDNS: true - включено, false - выключено.

Включение/выключение DDNS

PATCH /dns/ddns/state

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

{
    "enabled": "boolean"
}

• enabled - состояние DDNS: true - включено, false - выключено.

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

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

GET /dns/ddns

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

{
    "domain": "string",
    "service_login": "string",
    "service_password": "string"
}

• domain - домен, который администратор хочет видеть в адресной строке. Формат: domain.com (без https:// и www);

• service_login - логин для доступа к API сервиса DDNS;

• service_password - пароль для доступа к API сервиса DDNS, до 42 символов.

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

PATCH /dns/ddns

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

{
    "domain": "string",
    "service_login": "string",
    "service_password": "string"
}

• domain - домен, который администратор хочет видеть в адресной строке. Формат: domain.com (без https:// и www);

• service_login - логин для доступа к API сервиса DDNS;

• service_password - пароль для доступа к API сервиса DDNS, до 42 символов.

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