Получить DNS-записи домена

Внимание. Сервис Яндекс Почта для домена больше не поддерживается. API Почты для домена прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.

Документация API 360

Запрос позволяет получить все DNS-записи, которые были установлены для домена.

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода GET.

GET /api2/admin/dns/list?
domain=<имя домена> 

Host: pddimp.yandex.ru
PddToken: <ПДД-токен>

Заголовки:


Название	Описание
PddToken	ПДД-токен.

Параметры:


Параметр	Тип	Значение
domain	Строка	Имя домена.

GET /api2/registrar/dns/list?
domain=<имя домена> 

Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
Authorization: OAuth <OAuth-токен>

Заголовки:


Название	Описание
PddToken	ПДД-токен.
Authorization	OAuth-токен.

Параметры:


Параметр	Тип	Значение
domain	Строка	Имя домена.

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

GET /api2/admin/dns/list?domain=domain.com HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/dns/list?domain=domain.com'

GET /api2/admin/dns/list?domain=domain.com HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization:  OAuth 00123456789ABCDEF00000000000000000000000000000000000

cURL

curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/dns/list?domain=domain.com'

Структура ответа

{
  "domain": "{имя домена}",
  "records": 
  [ 
    {
      "record_id": "{идентификатор записи}",
      "type": "{тип записи}",     
      "domain": "{имя домена}",
      "fqdn": "{полное имя домена}",    
      "ttl": "{время жизни записи}",     
      "subdomain": "{имя поддомена}",     
      "content": "{содержимое записи}",
      "priority": "{приоритет записи}"    
    }, 
    ...
  ], 
  "success": "{статус выполнения запроса}"
}

{
  "domain": "{имя домена}", 
  "success": "{статус выполнения запроса}", 
  "error": "{код ошибки}"
}


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`records`	Массив	Атрибуты DNS-записей. Каждый объект массива соответствует отдельной DNS-записи.
`success`	Строка	Статус выполнения запроса. Возможные значения: `ok` — запрос выполнен успешно. `error` — запрос выполнен с ошибкой.
`error`	Строка	Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения: `unknown` — произошел временный сбой или ошибка работы API (повторите запрос позже). `no_token` (`no_domain`, `no_ip` ) — не передан обязательный параметр. `bad_domain` — имя домена не указано или не соответствует RFC. `prohibited` — запрещенное имя домена. `bad_token` (`bad_login`, `bad_passwd`) — передан неверный ПДД-токен (логин, пароль). `no_auth` — не передан заголовок `PddToken`. `not_allowed` — пользователю недоступна данная операция (он не является администратором этого домена). `blocked` — домен заблокирован (например, за спам и т.п.). `occupied` — имя домена используется другим пользователем. `domain_limit_reached` — превышено допустимое количество подключенных доменов (50). `no_reply` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объектов массива `records`
`record_id`	Число	Идентификатор DNS-записи.
`type`	Строка	Тип DNS-записи. Возможные значения: `SRV`; `TXT`; `NS`; `MX`; `SOA`; `A`; `AAAA`; `CNAME`.
`domain`	Строка	Имя домена.
`fqdn`	Строка	Полностью определенное имя домена (FQDN).
`ttl`	Число	Время жизни DNS-записи в секундах.
`subdomain`	Строка	Имя поддомена. Например, «my.domain.com» — имя поддомена домена «domain.com». Вместо «my.domain.com» можно использовать «my».
`content`	Строка	Содержимое DNS-записи.
`priority`	Число	Приоритет DNS-записи. Существует для MX и SRV-записей. Для остальных DNS-записей возвращается пустая строка.


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`records`	Массив	Атрибуты DNS-записей. Каждый объект массива соответствует отдельной DNS-записи.
`success`	Строка	Статус выполнения запроса. Возможные значения: `ok` — запрос выполнен успешно. `error` — запрос выполнен с ошибкой.
`error`	Строка	Код ошибки. Ключ включается в ответ, если запрос выполнен с ошибкой. Возможные значения: `unknown` — произошел временный сбой или ошибка работы API (повторите запрос позже). `no_token` (`no_domain`, `no_ip` ) — не передан обязательный параметр. `bad_domain` — имя домена не указано или не соответствует RFC. `prohibited` — запрещенное имя домена. `bad_token` (`bad_login`, `bad_passwd`) — передан неверный ПДД-токен (логин, пароль). `no_auth` — не передан заголовок `PddToken`. `not_allowed` — пользователю недоступна данная операция (он не является администратором этого домена). `blocked` — домен заблокирован (например, за спам и т.п.). `occupied` — имя домена используется другим пользователем. `domain_limit_reached` — превышено допустимое количество подключенных доменов (50). `no_reply` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объектов массива `records`
`record_id`	Число	Идентификатор DNS-записи.
`type`	Строка	Тип DNS-записи. Возможные значения: `SRV`; `TXT`; `NS`; `MX`; `SOA`; `A`; `AAAA`; `CNAME`.
`domain`	Строка	Имя домена.
`fqdn`	Строка	Полностью определенное имя домена (FQDN).
`ttl`	Число	Время жизни DNS-записи в секундах.
`subdomain`	Строка	Имя поддомена. Например, «my.domain.com» — имя поддомена домена «domain.com». Вместо «my.domain.com» можно использовать «my».
`content`	Строка	Содержимое DNS-записи.
`priority`	Число	Приоритет DNS-записи. Существует для MX и SRV-записей. Для остальных DNS-записей возвращается пустая строка.