DNS-сервер

Получение статуса службы 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 (перехватывать DNS запросы на серверы в интернет)
}

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

PUT /dns/settings

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

{
    "intercept_enabled": boolean
}

Ответ: 200 ОК

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

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

GET /dns/safesearch

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

{
	"enabled": boolean (переадресовывать DNS-запросы на безопасные домены поиска Google, Yandex, YouTube, Bing, DuckDuckGo, Qwant и Pixabay)
}

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

PUT /dns/safesearch

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

{
    "enabled": boolean
}

Ответ: 200 ОК

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

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

GET /dns/zones/root

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

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

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

• enabled - элемент включен/выключен;

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

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

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

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

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

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

POST /dns/zones/root

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

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

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

{
    "id": "string"
}

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

PATCH /dns/zones/root/<id записи>

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

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

Ответ: 200 ОК

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

DELETE /dns/zones/root/<id записи>

Ответ: 200 ОК

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

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

GET /dns/zones/forward

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

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

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

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

• enabled - зона включена/выключена;

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

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

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

POST /dns/zones/forward

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

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

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

{
    "id": "string"
}

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

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

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

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

Ответ: 200 ОК

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

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

Ответ: 200 ОК

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

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

GET /dns/zones/master

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

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

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

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

• enabled - зона включена/выключена;

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

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

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

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

POST /dns/zones/master

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

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

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

{
    "id": "string"
}

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

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

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

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

Ответ: 200 ОК

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

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

Ответ: 200 ОК

DDNS

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

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

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

GET /dns/ddns/state

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

{
    "enabled": false
}

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

PUT /dns/ddns/state

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

{
    "enabled": false
}

Ответ: 200 ОК

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

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 символов.

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

PUT /dns/ddns

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

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

Ответ: 200 ОК