Получить статус подключения домена

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

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

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

Яндекс Почта для домена проверяет статус подключения всех доменов по установленному графику (без участия пользователя).

Запрос позволяет получить результат последней проверки, дату и время ее выполнения, а также дату и время следующей проверки.

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

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

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

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

Заголовки:


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

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.

Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.

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

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

Заголовки:


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

Параметры:


Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.

Параметр	Тип	Значение
Обязательные
domain	Строка	Имя домена.

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

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

cURL

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

GET /api2/admin/domain/registration_status?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/domain/registration_status?domain=domain.com'

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

{
  "domain": "{имя домена}",
  "status": "{статус домена}",
  "stage":"{служебный ключ}", 
  "check_results": "{результат последней проверки}",  
  "next_check": "{дата и время следующей проверки}",
  "last_check": "{дата и время последней проверки}", 
  "secrets": 
  {    
    "name": "{название проверочного файла}", 
    "content": "{содержимое проверочного файла}"
  },
  "success": "{статус выполнения запроса}"
}

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


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`status`	Строка	Статус домена. Возможные значения: `domain-activate` — домен добавлен в Почту для домена, но не подтвержден. `mx-activate` — домен подтвержден, но MX-запись не настроена (почта не работает). `added` — домен подтвержден, MX-запись настроена.
`stage`	Строка	Ключ дублирует `status` в служебных целях. Возможные значения: `owner-check` — домен добавлен в Почту для домена, но не подтвержден. `mx-check` — домен подтвержден, но MX-запись не настроена. `added` — домен подтвержден, MX-запись настроена.
`check_results`	Строка	Результат последней проверки. Возможные значения: `ok` — домен подтвержден, MX-запись настроена (почта работает). `no-cname,no-file` — CNAME-запись и секретный файл не найдены. `bad-cname,bad-file` — CNAME-запись и секретный файл неверные. `no-cname,bad-file` — CNAME-запись не найдена, секретный файл неверный. `bad-cname,no-file` — CNAME-запись неверная, секретный файл не найден. `domain-not-found` — домен не найден. `occupied` — имя домена уже используется другим пользователем. `mx-wrong` — MX-запись неверная. `mx-not-found` — MX-запись не найдена.
`next_check`	Строка	Дата и время следующей проверки.
`last_check`	Строка	Дата и время последней проверки.
`secrets`	Объект	Секретные данные проверочного файла (или CNAME-записи). Ключ включается в ответ, если значение status равно `domain-activate`.
`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` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта `secrets`
`name`	Строка	Секретная часть имени проверочного файла (или CNAME-записи).
`content`	Строка	Секретное содержимое проверочного файла.


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`status`	Строка	Статус домена. Возможные значения: `domain-activate` — домен добавлен в Почту для домена, но не подтвержден. `mx-activate` — домен подтвержден, но MX-запись не настроена (почта не работает). `added` — домен подтвержден, MX-запись настроена.
`stage`	Строка	Ключ дублирует `status` в служебных целях. Возможные значения: `owner-check` — домен добавлен в Почту для домена, но не подтвержден. `mx-check` — домен подтвержден, но MX-запись не настроена. `added` — домен подтвержден, MX-запись настроена.
`check_results`	Строка	Результат последней проверки. Возможные значения: `ok` — домен подтвержден, MX-запись настроена (почта работает). `no-cname,no-file` — CNAME-запись и секретный файл не найдены. `bad-cname,bad-file` — CNAME-запись и секретный файл неверные. `no-cname,bad-file` — CNAME-запись не найдена, секретный файл неверный. `bad-cname,no-file` — CNAME-запись неверная, секретный файл не найден. `domain-not-found` — домен не найден. `occupied` — имя домена уже используется другим пользователем. `mx-wrong` — MX-запись неверная. `mx-not-found` — MX-запись не найдена.
`next_check`	Строка	Дата и время следующей проверки.
`last_check`	Строка	Дата и время последней проверки.
`secrets`	Объект	Секретные данные проверочного файла (или CNAME-записи). Ключ включается в ответ, если значение status равно `domain-activate`.
`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` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта `secrets`
`name`	Строка	Секретная часть имени проверочного файла (или CNAME-записи).
`content`	Строка	Секретное содержимое проверочного файла.