DNS

Получение списка DNS-зон
Создание DNS-зоны
Получение информации о DNS-зоне
Обновление DNS-зоны
Удаление DNS-зоны
Получение списка записей в DNS-зоне

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

URL: /api/v1/dns/zones/
Метод: GET
Результат: JSON

Параметры запроса

Необязательные параметры:

offset: int - Индекс первой строки выборки, начиная с 0
limit: int - Количество элементов в выборке в диапазоне от 10 до 100

Коды ответов

Код	Описание
200	Успешный запрос

Возвращаемое значение

count: int - Количество элементов
entities - Список dns-зон
- id: int - Идентификатор зоны
- name: str - Доменное имя зоны
- comment: str - Комментарий к зоне
- records_count: int - Количество записей в зоне
- ttl: int - Время обновления (TTL) записей в DNS
- soa_email: str - Электронная почта для SOA-записи в DNS
- is_in_transfer: bool - Находится ли зона в процессе передачи на другой аккаунт
- is_technical_zone: bool - Размещена ли зона на техническом домене
- secondary_dns: Список str - IP-адреса вторичных (Secondary) DNS-серверов

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

curl --request GET 'https://api-ms.netangels.ru/api/v1/dns/zones/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Создание DNS-зоны

URL: /api/v1/dns/zones/
Метод: POST
Результат: JSON

Параметры тела запроса

Обязательные параметры:

name: str - Название DNS-зоны

Необязательные параметры:

soa_email: str - Электронная почта для SOA-записи в DNS
ttl: int - Время обновления (TTL) записей в DNS

Коды ответов

Код	Описание
201	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

DNS-зона

id: int - Идентификатор зоны
name: str - Доменное имя зоны
comment: str - Комментарий к зоне
records_count: int - Количество записей в зоне
ttl: int - Время обновления (TTL) записей в DNS
soa_email: str - Электронная почта для SOA-записи в DNS
is_in_transfer: bool - Находится ли зона в процессе передачи на другой аккаунт
is_technical_zone: bool - Размещена ли зона на техническом домене
secondary_dns: Список str - IP-адреса вторичных (Secondary) DNS-серверов

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

curl --request POST 'https://api-ms.netangels.ru/api/v1/dns/zones/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "example.com", 
          "soa_email": "hostmaster@example.com", 
          "ttl": 1800 
    }'

Получение информации о DNS-зоне

URL: /api/v1/dns/zones/{id}/
Метод: GET
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - Идентификатор DNS-зоны

Коды ответов

Код	Описание
200	Успешный запрос
404	DNS-зона не найдена

Возвращаемое значение

DNS-зона

id: int - Идентификатор зоны
name: str - Доменное имя зоны
comment: str - Комментарий к зоне
records_count: int - Количество записей в зоне
ttl: int - Время обновления (TTL) записей в DNS
soa_email: str - Электронная почта для SOA-записи в DNS
is_in_transfer: bool - Находится ли зона в процессе передачи на другой аккаунт
is_technical_zone: bool - Размещена ли зона на техническом домене
secondary_dns: Список str - IP-адреса вторичных (Secondary) DNS-серверов

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

curl --request GET 'https://api-ms.netangels.ru/api/v1/dns/zones/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Обновление DNS-зоны

URL: /api/v1/dns/zones/{id}/
Метод: POST
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - Идентификатор DNS-зоны

Параметры тела запроса

Необязательные параметры:

name: str - Название DNS-зоны
soa_email: str - Электронная почта для SOA-записи в DNS
ttl: int - Дефолтное время обновления (TTL) записей в DNS
comment: str - Комментарий
secondary_dns: Список IP - IP-адреса вторичных (Secondary) DNS-серверов

Коды ответов

Код	Описание
200	Успешный запрос
400	Данные в запросе имеют неверный формат или отсутствуют обязательные параметры
404	DNS-зона не найдена

Возвращаемое значение

DNS-зона

id: int - Идентификатор зоны
name: str - Доменное имя зоны
comment: str - Комментарий к зоне
records_count: int - Количество записей в зоне
ttl: int - Время обновления (TTL) записей в DNS
soa_email: str - Электронная почта для SOA-записи в DNS
is_in_transfer: bool - Находится ли зона в процессе передачи на другой аккаунт
is_technical_zone: bool - Размещена ли зона на техническом домене
secondary_dns: Список str - IP-адреса вторичных (Secondary) DNS-серверов

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

curl --request POST 'https://api-ms.netangels.ru/api/v1/dns/zones/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "example.com", 
          "soa_email": "hostmaster@example.com", 
          "ttl": 1800, 
          "comment": "Комментарий к DNS-зоне", 
          "secondary_dns": ["127.0.0.1"] 
    }'

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

URL: /api/v1/dns/zones/{id}/
Метод: DELETE
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - Идентификатор DNS-зоны

Коды ответов

Код	Описание
200	Успешный запрос
404	DNS-зона не найдена

Возвращаемое значение

DNS-зона

id: int - Идентификатор зоны
name: str - Доменное имя зоны
comment: str - Комментарий к зоне
records_count: int - Количество записей в зоне
ttl: int - Время обновления (TTL) записей в DNS
soa_email: str - Электронная почта для SOA-записи в DNS
is_in_transfer: bool - Находится ли зона в процессе передачи на другой аккаунт
is_technical_zone: bool - Размещена ли зона на техническом домене
secondary_dns: Список str - IP-адреса вторичных (Secondary) DNS-серверов

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

curl --request DELETE 'https://api-ms.netangels.ru/api/v1/dns/zones/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Получение списка записей в DNS-зоне

URL: /api/v1/dns/zones/{id}/records/
Метод: GET
Результат: JSON

Параметры запроса

Обязательные параметры:

id: int - Идентификатор DNS-зоны

Необязательные параметры:

offset: int - Индекс первой строки выборки, начиная с 0
limit: int - Количество элементов в выборке в диапазоне от 10 до 100

Коды ответов

Код	Описание
200	Успешный запрос
404	DNS-зона не найдена

Возвращаемое значение

count: int - Количество элементов
entities - Список dns-записей
- id: int - Идентификатор записи
- zone_id: int - Идентификатор DNS-зоны, в которой находится запись
- name: str - Имя записи
- type: str - Тип записи:
  - A
  - AAAA
  - CNAME
  - MX
  - NS
  - SRV
  - TXT
  - CAA
- details: Details - Данные (в зависимости от типа записи)
  - A-запись
    - ip: str - IPv4-адрес
  - AAAA-запись
    - ip: str - IPv6-адрес
  - MX-запись
    - hostname: str - Полное доменное имя почтового сервера
    - ip: str - IP-адрес сервера
    - priority: int - Приоритет
  - TXT-запись
    - value: str - Текст записи
  - CNAME-запись
    - domain: str - Алиасом к какому домену является
  - NS-запись
    - nameserver: str - Доменное имя авторитетного DNS-сервера
  - CAA-запись
    - value: str - Значение CAA-записи
    - tag: str - Тег CAA-записи (RFC 8659, пункты 4.2-4.4):
      - Issue - Выпуск SSL-сертификатов разрешен для указанного в записи издателя
      - Issuewild - Выпуск Wildcard SSL-сертификатов разрешен для указанного в записи издателя
      - Iodef - В записи находится URL или адрес почты для сообщений об ошибках выпуска SSL
    - flag: str - Специальный флаг (RFC 8659, пункт 4.5):
      - Default - Издатель сертификата может продолжить выпуск, если не смог обработать эту CAA-запись
      - IssuerCritical - Издатель сертификата обязан отклонить выпуск, если не смог обработать эту CAA-запись
  - SRV-запись
    - hostname: str - Доменное имя назначения
    - port: int - Порт
    - priority: int - Приоритет
    - protocol: str - Название протокола
    - service: str - Сервис
    - weight: int - Вес

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

curl --request GET 'https://api-ms.netangels.ru/api/v1/dns/zones/{id}/records/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search