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

DNS

Создание DNS-записи

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

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

  • type: str - Тип DNS-записи:
    • A
    • AAAA
    • CNAME
    • MX
    • TXT
    • CAA
    • SRV
    • NS

Список остальных параметров зависит от типа записи.

A-запись

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

  • name: str – Название DNS-записи
  • ip: IP – IPv4-адрес

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

  • ttl: int – Время обновления (TTL) записи в DNS

AAAA-запись

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

  • name: str – Название DNS-записи
  • ip: IP – IPv6-адрес

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

  • ttl: int – Время обновления (TTL) записи в DNS

MX-запись

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

  • name: str – Название DNS-записи
  • hostname: str – Имя хоста, получающего почту

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

  • ttl: int – Время обновления (TTL) записи в DNS
  • ip: str – IP-адрес почтового сервера
  • priority: int – Приоритет MX-записи

TXT-запись

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

  • name: str – Название DNS-записи
  • value: str – Значение

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

  • ttl: int – Время обновления (TTL) записи в DNS

CNAME-запись

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

  • name: str – Название DNS-записи
  • domain: str – Алиасом к какому домену является

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

  • ttl: int – Время обновления (TTL) записи в DNS

NS-запись

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

  • name: str – Название DNS-записи
  • nameserver: str – Имя DNS-сервера

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

  • ttl: int – Время обновления (TTL) записи в DNS

CAA-запись

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

  • name: str – Название DNS-записи
  • value: str – Значение
  • flag: bool – Специальный флаг (RFC 8659, пункт 4.5):
    • False – Издатель сертификата может продолжить выпуск, если не смог обработать эту CAA-запись
    • True – Издатель сертификата обязан отклонить выпуск, если не смог обработать эту CAA-запись
  • tag: str – Тег CAA-записи (RFC 8659, пункты 4.2-4.4):
    • Issue – Выпуск SSL-сертификатов разрешен для указанного в записи издателя
    • Issuewild – Выпуск Wildcard SSL-сертификатов разрешен для указанного в записи издателя
    • Iodef – В записи находится URL или адрес почты для сообщений об ошибках выпуска SSL

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

  • ttl: int – Время обновления (TTL) записи в DNS

SRV-запись

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

  • name: str – Название DNS-записи
  • service: str – Сервис
  • protocol: str – Протокол
  • hostname: str – Доменное имя назначения
  • priority: int – Приоритет
  • weight: int – Вес
  • port: int – Порт

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

  • ttl: int – Время обновления (TTL) записи в DNS

Коды ответов

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

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

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 POST 'https://api-ms.netangels.ru/api/v1/dns/records/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "name.example.com", 
          "type": "A", 
          "ip": "127.0.0.1", 
          "ttl": 1800 
    }'

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

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

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

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

  • id: int – Идентификатор DNS-записи

Коды ответов

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

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

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/records/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Обновление DNS-записи

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

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

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

  • id: int – Идентификатор DNS-записи

A-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • ip: IP – IPv4-адрес

AAAA-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • ip: IP – IPv6-адрес

MX-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • hostname: str – Имя хоста, получающего почту
  • ip: str – IP-адрес почтового сервера
  • priority: int – Приоритет MX-записи

TXT-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • value: str – Значение

CNAME-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • domain: str – Алиасом к какому домену является

NS-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • nameserver: str – Имя DNS-сервера

CAA-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • value: str – Значение
  • flag: bool – Специальный флаг (RFC 8659, пункт 4.5)
  • tag: str – Тег CAA-записи (RFC 8659, пункты 4.2-4.4):
    • Issue – Выпуск SSL-сертификатов разрешен для указанного в записи издателя
    • Issuewild – Выпуск Wildcard SSL-сертификатов разрешен для указанного в записи издателя
    • Iodef – В записи находится URL или адрес почты для сообщений об ошибках выпуска SSL

SRV-запись

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

  • name: str – Название DNS-записи
  • ttl: int – Время обновления (TTL) записи в DNS
  • service: str – Сервис
  • protocol: str – Протокол
  • hostname: str – Доменное имя назначения
  • priority: int – Приоритет
  • weight: int – Вес
  • port: int – Порт

Коды ответов

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

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

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 POST 'https://api-ms.netangels.ru/api/v1/dns/records/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "name.example.com", 
          "ttl": 1800, 
          "ip": "127.0.0.1" 
    }'

Удаление DNS-записи

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

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

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

  • id: int – Идентификатор DNS-записи

Коды ответов

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

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

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 DELETE 'https://api-ms.netangels.ru/api/v1/dns/records/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"