Получить настройки домена

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

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

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

Запрос позволяет узнать текущие свойства домена: статус подключения и делегирования на Яндекс, язык и тему оформления интерфейса почтовых ящиков, режимы работы POP и IMAP.

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

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

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

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

Заголовки:


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

Параметры:


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

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

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

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

Заголовки:


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

Параметры:


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

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

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

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

cURL

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

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

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

{
  "domain": "{имя домена}",
  "status": "{статус домена}",
  "stage": "{служебный ключ}",  
  "delegated": "{статус делегирования домена на Яндекс}",
  "country": "{язык интерфейса}",
  "imap_enabled": "{статус работы IMAP}",
  "pop_enabled": "{статус работы POP}",
  "default_theme": "{идентификатор темы оформления}",
  "success": "{статус выполнения запроса}"
}

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


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`status`	Строка	Статус домена. Возможные значения: `domain-activate` — домен добавлен в Почту для домена, но не подтвержден. `mx-activate` — домен подтвержден, но MX-запись не настроена (почта не работает). `added` — домен подтвержден, MX-запись настроена. `none` — домен с заданным именем не существует.
`stage`	Строка	Ключ дублирует `status` в служебных целях. Возможные значения: `owner-check` — домен добавлен в Почту для домена, но не подтвержден. `mx-check` — домен подтвержден, но MX-запись не настроена. `added` — домен подтвержден, MX-запись настроена. `none` — домен с заданным именем не существует.
`delegated`	Строка	Статус делегирования домена на серверы Яндекса (`dns1.yandex.net` и `dns2.yandex.net`). Возможные значения: `yes` — домен делегирован. `no` — домен не делегирован.
`country`	Строка	Язык интерфейса для почтовых ящиков домена по умолчанию. Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Возможные значения: `ru` — русский. `en` — английский. `ua` — украинский. `tr` — турецкий. `by` — белорусский. `az` — азербайджанский. `ro` — румынский. `ge` — грузинский. `kz` — казахский.
`pop_enabled`	Число	Статус работы POP на домене. Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Возможные значения: `1` — POP включен. `0` — POP выключен. Примечание. При изменении статуса новый режим будет действовать только для вновь созданных почтовых ящиков.
`imap_enabled`	Число	Статус работы IMAP на домене. Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Возможные значения: `1` — IMAP включен. `0` — IMAP выключен. Примечание. При изменении статуса новый режим будет действовать только для вновь созданных почтовых ящиков.
`default_theme`	Строка	Идентификатор темы оформления для всех почтовых ящиков домена по умолчанию (например, `starwars` — идентификатор темы «Звёздные войны»). Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Если тема оформления не задана, значение ключа будет равно пустой строке.
`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` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.


Название	Тип значения	Описание
`domain`	Строка	Имя домена.
`status`	Строка	Статус домена. Возможные значения: `domain-activate` — домен добавлен в Почту для домена, но не подтвержден. `mx-activate` — домен подтвержден, но MX-запись не настроена (почта не работает). `added` — домен подтвержден, MX-запись настроена. `none` — домен с заданным именем не существует.
`stage`	Строка	Ключ дублирует `status` в служебных целях. Возможные значения: `owner-check` — домен добавлен в Почту для домена, но не подтвержден. `mx-check` — домен подтвержден, но MX-запись не настроена. `added` — домен подтвержден, MX-запись настроена. `none` — домен с заданным именем не существует.
`delegated`	Строка	Статус делегирования домена на серверы Яндекса (`dns1.yandex.net` и `dns2.yandex.net`). Возможные значения: `yes` — домен делегирован. `no` — домен не делегирован.
`country`	Строка	Язык интерфейса для почтовых ящиков домена по умолчанию. Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Возможные значения: `ru` — русский. `en` — английский. `ua` — украинский. `tr` — турецкий. `by` — белорусский. `az` — азербайджанский. `ro` — румынский. `ge` — грузинский. `kz` — казахский.
`pop_enabled`	Число	Статус работы POP на домене. Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Возможные значения: `1` — POP включен. `0` — POP выключен. Примечание. При изменении статуса новый режим будет действовать только для вновь созданных почтовых ящиков.
`imap_enabled`	Число	Статус работы IMAP на домене. Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Возможные значения: `1` — IMAP включен. `0` — IMAP выключен. Примечание. При изменении статуса новый режим будет действовать только для вновь созданных почтовых ящиков.
`default_theme`	Строка	Идентификатор темы оформления для всех почтовых ящиков домена по умолчанию (например, `starwars` — идентификатор темы «Звёздные войны»). Ключ включается в ответ, если домен подтвержден (то есть значение `status` равно `mx-activate` или `added`). Если тема оформления не задана, значение ключа будет равно пустой строке.
`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` — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.