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

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

Примечание

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

Request

POST

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

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

Body

application/json
{
    "domain": "string",
    "name": "string"
}

Name

Description

domain*

Type: string

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

name

Type: string

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

Responses

200 OK

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

Body

application/json
{
    "name": "string",
    "country": "string",
    "mx": false,
    "delegated": false,
    "master": false,
    "verified": false,
    "status": {
        "name": "string",
        "lastCheck": "2022-12-29T18:02:01Z",
        "lastAdded": "2022-12-29T18:02:01Z",
        "spf": {
            "match": false,
            "value": "string"
        },
        "mx": {
            "match": false,
            "value": "string"
        },
        "ns": {
            "match": false,
            "value": "string"
        },
        "dkim": {
            "match": false,
            "value": "string"
        }
    }
}

Name

Description

country

Type: string

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

delegated

Type: boolean

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

master

Type: boolean

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

mx

Type: boolean

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

name

Type: string

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

status

Type: v1DomainStatus

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

verified

Type: boolean

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

v1DomainStatus

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

Name

Description

dkim

Type: v1DomainStatatusValue

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

lastAdded

Type: string<date-time>

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

lastCheck

Type: string<date-time>

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

mx

Type: v1DomainStatatusValue

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

name

Type: string

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

ns

Type: v1DomainStatatusValue

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

spf

Type: v1DomainStatatusValue

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

v1DomainStatatusValue

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

Name

Description

match

Type: boolean

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

value

Type: string

Значение.

401 Unauthorized

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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

403 Forbidden

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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

404 Not Found

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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

500 Internal Server Error

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

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        null
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: any[]

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

message

Type: string

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