Просмотреть список доменов

Ограничение.

Запрос может быть выполнен только если:

  • приложение имеет разрешение на чтение данных о доменах;

  • запрос выполняется от имении администратора.

Запрос позволяет получить информацию о ваших доменах. Вы можете запросить как полную информацию о командах, так и только необходимые вам поля.

Формат запроса

Для получения списка доменов используйте HTTP-запрос с методом GET:

GET /v6/domains/?
fields=<параметр1>,<параметр2>, ...
Host: https://api.directory.yandex.net
Authorization: OAuth <токен>
X-Org-ID: <идентификатор организации>
Accept: application/json
Параметры запроса
fields (необязательный)

Список параметров доменов, которые вы хотите получить. Если параметр fields не указан, ответ содержит только список имен доменов. Подробнее о доступных параметрах доменов читайте в разделе Формат ответа.

Тип данных: строка.

Заголовки запроса
Host

Адрес узла, предоставляющего API:

https://api.directory.yandex.net
Authorization

OAuth-токен в формате OAuth <значение токена>, например:

OAuth 0c4181a7c2cf4521964a72ff57a34a07
X-Org-ID

Идентификатор организации. Заголовок необходимо передавать только если запрос выполняется от имени администратора нескольких организаций.

Accept

Допустимый формат ответа. Должен иметь значение application/json.

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200. Тело ответа содержит результаты в формате JSON:

[
  {
    "mx": <true|false>,
    "delegated": <true|false>,
    "tech": <true|false>,
    "pop_enabled": <true|false>,
    "master": <true|false>,
    "postmaster_uid": <идентификатор ящика по умолчанию>,
    "owned": <true|false>,
    "country": "<страна домена>",
    "name": "<полное имя домена>",
    "imap_enabled": true
  },
...
]
Параметры ответа

Тело ответа содержит массив объектов со сведениями о доменах. С помощью параметра fields запроса вы можете ограничить перечень полей домена, содержащихся в ответе. Если параметр fields не задан, ответ содержит только список имен доменов.

Параметр Описание Тип данных
mx

Указывает ли mx-запись на север mx.yandex.net:

  • true — указывает;

  • false — не указывает.

Логический.

delegated

Признак домена, делегированного на серверы Яндекса:

  • true — делегирован;

  • false — не делегирован.

Логический.

tech

Признак технического домена (домен вида <ваш домен>.yaconnect.com)

  • true — технический домен;

  • false — обычный домен.

Логический.

pop_enabled

Доступ к почтовым ящикам домена по протоколу POP:

  • true — включен;

  • false — выключен.

Логический..

master

Признак основного домена:

  • true — основной домен;

  • false — домен-алиас.

Логический.

postmaster_uid

Идентификатор почтового ящика по умолчанию.

Целое число.

owned

Признак подтвержденного домена:

  • true — домен подтвержден;

  • false — домен не подтвержден.

Логический.

country Страна домена.

Строка.

name

Полное доменное имя.

Строка.

imap_enabled

Доступ к почтовым ящикам домена по протоколу IMAP:

  • true — включен;

  • false — выключен.

Логический.

Параметр Описание Тип данных
mx

Указывает ли mx-запись на север mx.yandex.net:

  • true — указывает;

  • false — не указывает.

Логический.

delegated

Признак домена, делегированного на серверы Яндекса:

  • true — делегирован;

  • false — не делегирован.

Логический.

tech

Признак технического домена (домен вида <ваш домен>.yaconnect.com)

  • true — технический домен;

  • false — обычный домен.

Логический.

pop_enabled

Доступ к почтовым ящикам домена по протоколу POP:

  • true — включен;

  • false — выключен.

Логический..

master

Признак основного домена:

  • true — основной домен;

  • false — домен-алиас.

Логический.

postmaster_uid

Идентификатор почтового ящика по умолчанию.

Целое число.

owned

Признак подтвержденного домена:

  • true — домен подтвержден;

  • false — домен не подтвержден.

Логический.

country Страна домена.

Строка.

name

Полное доменное имя.

Строка.

imap_enabled

Доступ к почтовым ящикам домена по протоколу IMAP:

  • true — включен;

  • false — выключен.

Логический.