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

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

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

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

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

Ответ возвращается постранично, его параметры можно задать в запросе.

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

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

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

GET /api2/admin/domain/domains?
[page=<номер страницы ответа>]
[on_page=<количество доменов на каждой странице ответа>]

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

Заголовки:

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

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

ПДД-токен.

Параметры:

Параметр Тип Значение
Необязательные
page Число

Номер страницы ответа. Значение по умолчанию — 1.
on_page Число

Количество доменов на каждой странице ответа. Допустимые значения: от 1 до 20. Значение по умолчанию — 10.
Параметр Тип Значение
Необязательные
page Число

Номер страницы ответа. Значение по умолчанию — 1.
on_page Число

Количество доменов на каждой странице ответа. Допустимые значения: от 1 до 20. Значение по умолчанию — 10.

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

GET /api2/admin/domain/domains?page=2&on_page=5 HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/domain/domains'

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

{
  "page": "{номер страницы ответа}", 
  "on_page": "{количество доменов на каждой странице ответа}", 
  "total": "{общее количество доменов пользователя}", 
  "found": "{количество доменов на текущей странице ответа}",
  "domains": 
  [ 
    {
      "name":"{имя домена}",
      "status": "{статус домена}", 
      "stage":"{служебный ключ}",   
      "aliases": 
        [
          "{имя алиаса}", 
          ...
        ],    
      "logo_enabled": "{признак наличия логотипа}", 
      "logo_url": "{URL логотипа}",    
      "nsdelegated": "{статус делегирования домена}", 
      "master_admin": "{статус пользователя}",    
      "emails-max-count": "{максимально возможное количество почтовых ящиков}", 
      "emails-count": "{количество почтовых ящиков}",
      "nodkim": "{признак того, что DKIM не подключен}"
    }, 
    ...
  ], 
  "success": "{статус выполнения запроса}"
}
Название Тип значения Описание
page Число

Номер страницы ответа. Значение параметра page, заданное в запросе. Если значение параметра не задано, используется его значение по умолчанию.
on_page Число

Количество доменов на каждой странице ответа. Значение параметра on_page, заданное в запросе.
total Число

Общее количество доменов пользователя.
found Число

Количество доменов на текущей странице ответа (может отличаться от значения ключа on_page для последней страницы в меньшую сторону).
domains Массив

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

Ключ включается в ответ, если у пользователя есть хотя бы один домен, который подтвержден или ожидает подтверждения.
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 — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объектов массива domains
name Строка

Имя домена.
status Строка

Статус домена.

Возможные значения:
  • domain-activate — домен добавлен в Почту для домена, но не подтвержден.
  • mx-activate — домен подтвержден, но MX-запись не настроена (почта не работает).
  • added — домен подтвержден, MX-запись настроена.
stage Строка

Ключ дублирует status в служебных целях.

Возможные значения:
  • owner-check — домен добавлен в Почту для домена, но не подтвержден.
  • mx-check — домен подтвержден, но MX-запись не настроена.
  • added — домен подтвержден, MX-запись настроена.
aliases Массив

Список алиасов домена.
logo_enabled Логический

Наличие логотипа домена.

Возможные значения:
logo_url Строка

URL логотипа домена.
nsdelegated Строка

Статус делегирования домена на серверы Яндекса (dns1.yandex.net и dns2.yandex.net).

Возможные значения:
  • yes — домен делегирован.
  • no — домен не делегирован.
master_admin Логический

Статус пользователя.

Возможные значения:
  • true — пользователь является администратором домена.
  • false — пользователь не является администратором домена.
dkim-ready Логический

Статус подключения DKIM.

Возможные значения:
  • true — исходящие письма подписываются подписью DKIM.
  • false — исходящие письма не подписываются подписью DKIM (см. запрос Подключить DKIM).
emails-max-count Число

Максимальное количество почтовых ящиков, которое можно создать для домена.
emails-count Число

Количество имеющихся почтовых ящиков.
nodkim Логический

Признак того, что DKIM не подключен для домена.

Ключ включается в ответ для подтвержденного домена.

Возможное значение: true.
Название Тип значения Описание
page Число

Номер страницы ответа. Значение параметра page, заданное в запросе. Если значение параметра не задано, используется его значение по умолчанию.
on_page Число

Количество доменов на каждой странице ответа. Значение параметра on_page, заданное в запросе.
total Число

Общее количество доменов пользователя.
found Число

Количество доменов на текущей странице ответа (может отличаться от значения ключа on_page для последней страницы в меньшую сторону).
domains Массив

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

Ключ включается в ответ, если у пользователя есть хотя бы один домен, который подтвержден или ожидает подтверждения.
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 — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объектов массива domains
name Строка

Имя домена.
status Строка

Статус домена.

Возможные значения:
  • domain-activate — домен добавлен в Почту для домена, но не подтвержден.
  • mx-activate — домен подтвержден, но MX-запись не настроена (почта не работает).
  • added — домен подтвержден, MX-запись настроена.
stage Строка

Ключ дублирует status в служебных целях.

Возможные значения:
  • owner-check — домен добавлен в Почту для домена, но не подтвержден.
  • mx-check — домен подтвержден, но MX-запись не настроена.
  • added — домен подтвержден, MX-запись настроена.
aliases Массив

Список алиасов домена.
logo_enabled Логический

Наличие логотипа домена.

Возможные значения:
logo_url Строка

URL логотипа домена.
nsdelegated Строка

Статус делегирования домена на серверы Яндекса (dns1.yandex.net и dns2.yandex.net).

Возможные значения:
  • yes — домен делегирован.
  • no — домен не делегирован.
master_admin Логический

Статус пользователя.

Возможные значения:
  • true — пользователь является администратором домена.
  • false — пользователь не является администратором домена.
dkim-ready Логический

Статус подключения DKIM.

Возможные значения:
  • true — исходящие письма подписываются подписью DKIM.
  • false — исходящие письма не подписываются подписью DKIM (см. запрос Подключить DKIM).
emails-max-count Число

Максимальное количество почтовых ящиков, которое можно создать для домена.
emails-count Число

Количество имеющихся почтовых ящиков.
nodkim Логический

Признак того, что DKIM не подключен для домена.

Ключ включается в ответ для подтвержденного домена.

Возможное значение: true.