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

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

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

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

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

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

GET /api2/admin/domain/domains?
[page
[no-highlight[

Тип

Число

Значение

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

]no-highlight]
=<номер страницы ответа>] [on_page
[no-highlight[

Тип

Число

Значение

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

]no-highlight]
=<количество доменов на каждой странице ответа>] Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

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

Заголовки:

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

ПДД-токен.

Параметры:

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

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

on_page Число

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

GET /api2/registrar/domain/domains?
[page
[no-highlight[

Тип

Число

Значение

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

]no-highlight]
=<номер страницы ответа>] [on_page
[no-highlight[

Тип

Число

Значение

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

]no-highlight]
=<количество доменов на каждой странице ответа>] Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

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

Описание

OAuth-токен.

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

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

ПараметрТипЗначение
Необязательные
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'
GET /api2/registrar/domain/domains?page=2&on_page=5 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/registrar/domain/domains'

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

{
  "page
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{номер страницы ответа}", "on_page
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{количество доменов на каждой странице ответа}", "total
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{общее количество доменов пользователя}", "found
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{количество доменов на текущей странице ответа}", "domains
[no-highlight[

Тип значения

Массив

Описание

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

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

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

Тип значения

Строка

Описание

Имя домена.

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

Тип значения

Строка

Описание

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

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

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

]no-highlight]
": "{статус домена}", "stage
[no-highlight[

Тип значения

Строка

Описание

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

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

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

]no-highlight]
":"{служебный ключ}", "aliases
[no-highlight[

Тип значения

Массив

Описание

Список алиасов домена.

]no-highlight]
": [ "{имя алиаса}", ... ], "logo_enabled
[no-highlight[

Тип значения

Логический

Описание

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

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

]no-highlight]
": "{признак наличия логотипа}", "logo_url
[no-highlight[

Тип значения

Строка

Описание

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

]no-highlight]
": "{URL логотипа}", "nsdelegated
[no-highlight[

Тип значения

Строка

Описание

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

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

  • yes — домен делегирован.
  • no — домен не делегирован.

]no-highlight]
": "{статус делегирования домена}", "master_admin
[no-highlight[

Тип значения

Логический

Описание

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

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

  • true — пользователь является администратором домена.
  • false — пользователь не является администратором домена.

]no-highlight]
": "{статус пользователя}", "emails-max-count
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{максимально возможное количество почтовых ящиков}", "emails-count
[no-highlight[

Тип значения

Число

Описание

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

]no-highlight]
": "{количество почтовых ящиков}", "nodkim
[no-highlight[

Тип значения

Логический

Описание

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

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

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

]no-highlight]
": "{признак того, что DKIM не подключен}" }, ... ], "success
[no-highlight[

Тип значения

Строка

Описание

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

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

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

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