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

  1. HTTP-запрос
  2. Path-параметры
  3. Тело запроса
    1. Представление
    2. Поля
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 404
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля

Используется, чтобы подключить новый домен.

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

HTTP-запрос

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

Path-параметры

orgId *

integer

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

orgId *

integer

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

Тело запроса

{
  "domain": string,
  "name": string
}
Скопировано

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

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

Поля

domain *

string

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

name

string

Устарело. используйте поле domain.

domain *

string

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

name

string

Устарело. используйте поле domain.

Ответы

Код 200

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

{
  "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
}
Скопировано

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

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

Поля

country

string

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

delegated

boolean

Признак домена, делегированного на серверы Яндекса. true — делегирован; false — не делегирован.

master

boolean

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

mx

boolean

Указывает ли MX-запись на сервер mx.yandex.net. true — указывает; false — не указывает.

name

string

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

status

object

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

status.dkim

object

Значение статуса проверки.

status.dkim.match

boolean

status.dkim.value

string

status.lastAdded

string

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

status.lastCheck

string

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

status.mx

object

Значение статуса проверки.

status.mx.match

boolean

status.mx.value

string

status.name

string

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

status.ns

object

Значение статуса проверки.

status.ns.match

boolean

status.ns.value

string

status.spf

object

Значение статуса проверки.

status.spf.match

boolean

status.spf.value

string

verified

boolean

Признак подтвержденного домена. true — подтвержден; false — не подтвержден.

country

string

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

delegated

boolean

Признак домена, делегированного на серверы Яндекса. true — делегирован; false — не делегирован.

master

boolean

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

mx

boolean

Указывает ли MX-запись на сервер mx.yandex.net. true — указывает; false — не указывает.

name

string

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

status

object

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

status.dkim

object

Значение статуса проверки.

status.dkim.match

boolean

status.dkim.value

string

status.lastAdded

string

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

status.lastCheck

string

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

status.mx

object

Значение статуса проверки.

status.mx.match

boolean

status.mx.value

string

status.name

string

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

status.ns

object

Значение статуса проверки.

status.ns.match

boolean

status.ns.value

string

status.spf

object

Значение статуса проверки.

status.spf.match

boolean

status.spf.value

string

verified

boolean

Признак подтвержденного домена. true — подтвержден; false — не подтвержден.

Код 401

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

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

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

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

Поля

code

integer

details[]

array

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

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

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

code

integer

details[]

array

details[].@type

string

message

string