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

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

Примечание

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

Request

GET

https://api360.yandex.net/directory/v1/org/{orgId}/domains

Path parameters

Name

Description

orgId

Type: integer

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

Query parameters

Name

Description

page

Type: integer

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

perPage

Type: integer

Количество доменов на одной странице ответа. Максимальное значение — 10.

Responses

200 OK

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

Body

application/json

{
  "domains": [
    {
      "name": "example",
      "country": "example",
      "mx": true,
      "delegated": true,
      "master": true,
      "verified": true,
      "status": {
        "name": "example",
        "lastCheck": "2025-01-01T00:00:00Z",
        "lastAdded": "2025-01-01T00:00:00Z",
        "spf": {
          "match": true,
          "value": "example"
        },
        "mx": null,
        "ns": null,
        "dkim": null
      }
    }
  ],
  "page": 0,
  "pages": 0,
  "perPage": 0,
  "total": 0
}

Name	Description
domains	Type: v1Domain[] Список доменов. Example `[ { "name": "example", "country": "example", "mx": true, "delegated": true, "master": true, "verified": true, "status": { "name": "example", "lastCheck": "2025-01-01T00:00:00Z", "lastAdded": "2025-01-01T00:00:00Z", "spf": { "match": true, "value": "example" }, "mx": null, "ns": null, "dkim": null } } ]`
page	Type: integer Номер страницы ответа.
pages	Type: integer Количество страниц ответа.
perPage	Type: integer Количество доменов на одной странице ответа.
total	Type: integer Общее количество доменов.

v1DomainStatatusValue

Статус и значение записи.

Name

Description

match

Type: boolean

Статус записи: true — запись настроена; false — нет.

value

Type: string

Значение.

Example: example

Example

{
  "match": true,
  "value": "example"
}

v1DomainStatus

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

Name	Description
dkim	Type: v1DomainStatatusValue Статус DKIM-записи домена. Статус и значение записи. Example `{ "match": true, "value": "example" }`
lastAdded	Type: string<date-time> Дата и время добавления домена. Example: `2025-01-01T00:00:00Z`
lastCheck	Type: string<date-time> Дата и время последней проверки. Example: `2025-01-01T00:00:00Z`
mx	Type: v1DomainStatatusValue Статус MX-записи домена. Статус и значение записи. Example `{ "match": true, "value": "example" }`
name	Type: string Полное доменное имя. Например `example.com`. Для кириллических доменов (например `домен.рф`) используйте кодировку Punycode. Example: `example`
ns	Type: v1DomainStatatusValue Статус NS-записи домена. Статус и значение записи. Example `{ "match": true, "value": "example" }`
spf	Type: v1DomainStatatusValue Статус SPF-записи домена. Статус и значение записи. Example `{ "match": true, "value": "example" }`

Example

{
  "name": "example",
  "lastCheck": "2025-01-01T00:00:00Z",
  "lastAdded": "2025-01-01T00:00:00Z",
  "spf": {
    "match": true,
    "value": "example"
  },
  "mx": null,
  "ns": null,
  "dkim": null
}

v1Domain

Домен.

Name	Description
country	Type: string Страна домена. Example: `example`
delegated	Type: boolean Признак домена, делегированного на серверы Яндекса: `true` — делегирован; `false` — не делегирован.
master	Type: boolean Признак основного домена: `true` — основной; `false` — домен-алиас (дополнительный).
mx	Type: boolean Указывает ли MX-запись на сервер `mx.yandex.net`: `true` — указывает; `false` — не указывает.
name	Type: string Полное доменное имя. Example: `example`
status	Type: v1DomainStatus Статус домена и DNS-записей. Статус домена. Example `{ "name": "example", "lastCheck": "2025-01-01T00:00:00Z", "lastAdded": "2025-01-01T00:00:00Z", "spf": { "match": true, "value": "example" }, "mx": null, "ns": null, "dkim": null }`
verified	Type: boolean Признак подтвержденного домена: `true` — подтвержден; `false` — не подтвержден.

Example

{
  "name": "example",
  "country": "example",
  "mx": true,
  "delegated": true,
  "master": true,
  "verified": true,
  "status": {
    "name": "example",
    "lastCheck": "2025-01-01T00:00:00Z",
    "lastAdded": "2025-01-01T00:00:00Z",
    "spf": {
      "match": true,
      "value": "example"
    },
    "mx": null,
    "ns": null,
    "dkim": null
  }
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null

Example

{
  "@type": "example"
}

401 Unauthorized

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

403 Forbidden

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

404 Not Found

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

500 Internal Server Error

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

Body

application/json

{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Name	Description
code	Type: integer Код ошибки.
details	Type: protobufAny[] Дополнительные сведения об ошибке. Example `[ { "@type": "example" } ]`
message	Type: string Описание ошибки. Example: `example`

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

Обзор

Добавить домен