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

Справочник API 360

Возвращает список доменов организации.

Ограничение. Требуется разрешение на чтение данных о доменах.

HTTP-запрос

GET https://api360.yandex.net/directory/v1/org/{orgId}/domains\
?page={integer}\
&perPage={integer}

Path-параметры

orgId *

integer

Идентификатор организации.

* Обязательный параметр

Query-параметры

page	integer Номер страницы ответа. Значение по умолчанию — `1`.
perPage	integer Количество доменов на одной странице ответа. Максимальное значение — `10`.

* Обязательный параметр

Ответы

Код 200

Запрос успешно выполнен.

{
  "domains": [
    {
      "country": string,
      "delegated": boolean,
      "master": boolean,
      "mx": boolean,
      "name": string,
      "status": {
        "dkim": {
          "match": boolean,
          "value": string
        },
        "lastAdded": string,
        "lastCheck": string,
        "mx": {
          "match": boolean,
          "value": string
        },
        "name": string,
        "ns": {
          "match": boolean,
          "value": string
        },
        "spf": {
          "match": boolean,
          "value": string
        }
      },
      "verified": boolean
    }
  ],
  "page": integer,
  "pages": integer,
  "perPage": integer,
  "total": integer
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

domains[]	array Список доменов.
domains[].country	string Страна домена.
domains[].delegated	boolean Признак домена, делегированного на серверы Яндекса. `true` — делегирован; `false` — не делегирован.
domains[].master	boolean Признак основного домена. `true` — основной; `false` — домен-алиас (дополнительный).
domains[].mx	boolean Указывает ли MX-запись на сервер `mx.yandex.net`. `true` — указывает; `false` — не указывает.
domains[].name	string Полное доменное имя.
domains[].status	object Статус домена.
domains[].status.dkim	object Значение статуса проверки.
domains[].status.dkim.match	boolean
domains[].status.dkim.value	string
domains[].status.lastAdded	string Дата и время добавления домена.
domains[].status.lastCheck	string Дата и время последней проверки.
domains[].status.mx	object Значение статуса проверки.
domains[].status.mx.match	boolean
domains[].status.mx.value	string
domains[].status.name	string Полное доменное имя. Например `example.com`. Для кириллических доменов (например `домен.рф`) используйте кодировку Punycode.
domains[].status.ns	object Значение статуса проверки.
domains[].status.ns.match	boolean
domains[].status.ns.value	string
domains[].status.spf	object Значение статуса проверки.
domains[].status.spf.match	boolean
domains[].status.spf.value	string
domains[].verified	boolean Признак подтвержденного домена. `true` — подтвержден; `false` — не подтвержден.
page	integer Номер страницы ответа.
pages	integer Количество страниц ответа.
perPage	integer Количество доменов на одной странице ответа.
total	integer Общее количество доменов.

* Обязательный параметр

Код 401

Пользователь не авторизован.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Код 403

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Код 404

Запрашиваемый ресурс не найден.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Код 500

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

{
  "code": integer,
  "details": [
    {
      "@type": string
    }
  ],
  "message": string
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

code	integer
details[]	array
details[].@type	string
message	string

* Обязательный параметр

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

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

Удалить домен

В этой статье

HTTP-запрос Path-параметры Query-параметры Ответы Код 200 Представление Поля Код 401 Представление Поля Код 403 Представление Поля Код 404 Представление Поля Код 500 Представление Поля

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

Удалить домен