Поиск правил маршрутизации

Возвращает список правил маршрутизации:

  • для указанных доменов, если они перечислены в запросе;
  • для всех правил маршрутизации в организации, если в запросе указан пустой объект.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение:

  • ya360_admin:mail_read_domain_routes — чтение правил маршрутизации организации.

Запрос

POST https://cloud-api.yandex.net/v1/mail/organizations/{org_id}/routes/search

Path-параметры

Имя параметра

Тип

Описание

org_id *

integer

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

Заголовки

Authorization: OAuth <токен>
Content-Type: application/json

Тело запроса

Имя параметра

Тип

Описание

items

SchemaRoutingRecipientDomain[]

Список доменов для поиска. Среди доменов в теле запроса не должно быть некорректных и одинаковых.

Возможное количество доменов в запросе: от 1 до 1000.

Если в запросе не указан список доменов, в ответе вернется список всех правил маршрутизации организации.

SchemaRoutingRecipientDomain

Имя параметра

Тип

Описание

recipient_domain *

string

Домен получателя письма.

Пример

Пример запроса для указанных доменов
curl -X POST -H "Authorization: OAuth <токен>" -H "Content-Type: application/json" -d '{
  "items": [
    {
      "recipient_domain": "example.com"
    },
    {
      "recipient_domain": "test.org"
    }
  ]
}' https://cloud-api.yandex.net/v1/mail/organizations/1234567/routes/search
Пример запроса всех правил маршрутизации
curl -X POST -H "Authorization: OAuth <токен>" -H "Content-Type: application/json" -d '{}' https://cloud-api.yandex.net/v1/mail/organizations/1234567/routes/search

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком правил маршрутизации.

200 OK — запрос выполнен успешно.

Имя параметра

Тип

Описание

items *

SchemaRoutingRuleAdminSearch[]

Массив объектов SchemaRoutingRuleAdminSearch.

SchemaRoutingRuleAdminSearch

Имя параметра

Тип

Описание

recipient_domain *

string

Домен получателя письма.

relay *

string

Адрес почтового сервера.

recipient_category *

string

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

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

  • ALL_RECIPIENTS — все получатели.

  • EXTERNAL_RECIPIENTS — внешние получатели:

    • Для правил с указанным доменом категория EXTERNAL_RECIPIENTS означает получателей, которые не являются Яндекс-получателями и у которых нет UID в blackbox.
    • Для правил с пустым доменом ("") категория EXTERNAL_RECIPIENTS означает внешних по отношению к организации получателей.

description

string

Описание правила маршрутизации.

created_at *

string<date-time>

Дата и время создания или обновления правила маршрутизации.

Пример

Пример ответа
{
  "items": [
    {
      "recipient_domain": "example.com",
      "relay": "mx.example.com",
      "recipient_category": "EXTERNAL_RECIPIENTS",
      "description": "Маршрутизация для внешних получателей",
      "created_at": "2026-01-23T08:00:00Z"
    },
    {
      "recipient_domain": "test.org",
      "relay": "mx.test.org",
      "recipient_category": "ALL_RECIPIENTS",
      "description": "Маршрутизация для всех получателей",
      "created_at": "2026-01-23T08:00:00Z"
    }
  ]
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

  • 400 Bad Request — параметры запроса не заданы или заданы неверно;
  • 401 Unauthorized — пользователь не авторизован;
  • 403 Forbidden — у пользователя или приложения нет прав на доступ к правилам маршрутизации;
  • 405 Method Not Allowed — неподдерживаемый HTTP-метод;
  • 422 Unprocessable Entity — ошибки в спецификации запроса;
  • 500 Internal Server Error — ошибка произошла на стороне сервера.

Если доступна подробная информацию об ошибке, вы можете посмотреть ее в поле details в теле ответа.

Предыдущая
Обзор
Следующая
Создание и обновление правил маршрутизации