---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.ru/dev/api360/doc/ru/ref/DomainService/DomainService_List.md
  - href: ru/ref/DomainService/DomainService_List.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/api360/doc/ru/llms.txt

<div class="openapi">

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

<!-- markdownlint-disable-file -->

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

{% note info %}

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

{% endnote %}

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://api360.yandex.net/directory/v1/org/{orgId}/domains
```

</div>

</div>

</div>

### Path parameters

#|
|| **Name** | **Description** ||
||

_orgId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Идентификатор организации.
{.table-cell}
||
|#{.json-schema-properties}

### Query parameters

#|
|| **Name** | **Description** ||
||

_page_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Номер страницы ответа. Значение по умолчанию — `1`.
{.table-cell}
||
||

_perPage_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Количество доменов на одной странице ответа. Максимальное значение — `10`.
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__200">

## 200 OK

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_domains_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1Domain](#entity-v1Domain)[]

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "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
    }
  }
]
```

{% endcut %}
{.table-cell}
||
||

_page_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Номер страницы ответа.
{.table-cell}
||
||

_pages_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Количество страниц ответа.
{.table-cell}
||
||

_perPage_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Количество доменов на одной странице ответа.
{.table-cell}
||
||

_total_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Общее количество доменов.
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### v1DomainStatatusValue {#entity-v1DomainStatatusValue}

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

#|
|| **Name** | **Description** ||
||

_match_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Статус записи: `true` — запись настроена; `false` — нет.
{.table-cell}
||
||

_value_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Значение.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "match": true,
  "value": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### v1DomainStatus {#entity-v1DomainStatus}

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

#|
|| **Name** | **Description** ||
||

_dkim_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1DomainStatatusValue](#entity-v1DomainStatatusValue)

Статус DKIM-записи домена.

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "match": true,
  "value": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_lastAdded_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Дата и время добавления домена.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_lastCheck_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

Дата и время последней проверки.

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_mx_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1DomainStatatusValue](#entity-v1DomainStatatusValue)

Статус MX-записи домена.

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "match": true,
  "value": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Полное доменное имя. Например `example.com`. Для кириллических доменов (например `домен.рф`) используйте кодировку Punycode.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_ns_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1DomainStatatusValue](#entity-v1DomainStatatusValue)

Статус NS-записи домена.

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "match": true,
  "value": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_spf_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1DomainStatatusValue](#entity-v1DomainStatatusValue)

Статус SPF-записи домена.

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "match": true,
  "value": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### v1Domain {#entity-v1Domain}

Домен.

#|
|| **Name** | **Description** ||
||

_country_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_delegated_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Признак домена, делегированного на серверы Яндекса: `true` — делегирован; `false` — не делегирован.
{.table-cell}
||
||

_master_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Признак основного домена: `true` — основной; `false` — домен-алиас (дополнительный).
{.table-cell}
||
||

_mx_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Указывает ли MX-запись на сервер `mx.yandex.net`: `true` — указывает; `false` — не указывает.
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [v1DomainStatus](#entity-v1DomainStatus)

Статус домена и DNS-записей.

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}
{.table-cell}
||
||

_verified_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Признак подтвержденного домена: `true` — подтвержден; `false` — не подтвержден.
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
  }
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### protobufAny {#entity-protobufAny}

#|
|| **Name** | **Description** ||
||

_@type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_[additional]_{.json-schema-reset .json-schema-additional-property}
{.table-cell}|
**Type**: unknown

_Example:_{.json-schema-reset .json-schema-example} `null`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "@type": "example"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": 0,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Код ошибки.
{.table-cell}
||
||

_details_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [protobufAny](#entity-protobufAny)[]

Дополнительные сведения об ошибке.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "@type": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

Описание ошибки.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.