Документация
API Яндекс.Почты для домена

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

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

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

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

GET /api2/admin/dns/list?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен>

Заголовки:

НазваниеОписание
PddToken

ПДД-токен.

Параметры:

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

Имя домена.

GET /api2/registrar/dns/list?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Authorization
[no-highlight[

Описание

OAuth-токен.

]no-highlight]
: 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
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "records
[no-highlight[

Тип значения

Массив

Описание

Атрибуты DNS-записей. Каждый объект массива соответствует отдельной DNS-записи.

]no-highlight]
": [ { "record_id
[no-highlight[

Тип значения

Число

Описание

Идентификатор DNS-записи.

]no-highlight]
": "{идентификатор записи}", "type
[no-highlight[

Тип значения

Строка

Описание

Тип DNS-записи.

Возможные значения:

  • SRV;
  • TXT;
  • NS;
  • MX;
  • SOA;
  • A;
  • AAAA;
  • CNAME.

]no-highlight]
": "{тип записи}", "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "fqdn
[no-highlight[

Тип значения

Строка

Описание

Полностью определенное имя домена (FQDN).

]no-highlight]
": "{полное имя домена}", "ttl
[no-highlight[

Тип значения

Число

Описание

Время жизни DNS-записи в секундах.

]no-highlight]
": "{время жизни записи}", "subdomain
[no-highlight[

Тип значения

Строка

Описание

Имя поддомена. Например, «my.domain.com» — имя поддомена домена «domain.com». Вместо «my.domain.com» можно использовать «my».

]no-highlight]
": "{имя поддомена}", "content
[no-highlight[

Тип значения

Строка

Описание

Содержимое DNS-записи.

]no-highlight]
": "{содержимое записи}", "priority
[no-highlight[

Тип значения

Число

Описание

Приоритет DNS-записи. Существует для MX и SRV-записей. Для остальных DNS-записей возвращается пустая строка.

]no-highlight]
": "{приоритет записи}" }, ... ], "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}" }
{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "success
[no-highlight[

Тип значения

Строка

Описание

Статус выполнения запроса.

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}", "error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:

  • 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 — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.

]no-highlight]
": "{код ошибки}" }
НазваниеТип значенияОписание
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-записей возвращается пустая строка.