Получить статус подключения домена

Проверяет статус подключения всех доменов.

Запрос позволяет получить результат последней проверки, дату и время ее выполнения, а также дату и время следующей проверки.

Примечание

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

Request

GET

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

Path parameters

Name

Description

domain

Type: string

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

Example: ``

orgId

Type: integer

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

Responses

200 OK

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

Body

application/json

{
  "status": "example",
  "methods": [
    {
      "method": "example",
      "code": "example"
    }
  ]
}

Name

Description

methods

Type: v1ConfirmationMethod[]

Методы подтверждения.

Example

[
  {
    "method": "example",
    "code": "example"
  }
]

status

Type: string

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

Example: example

v1ConfirmationMethod

Name

Description

code

Type: string

Код подтверждения.

Example: example

method

Type: string

Метод подтверждения. Подробнее см. в разделе Подтвердить домен и настроить сервер Справки Яндекс 360 для бизнеса.

Example: example

Example

{
  "method": "example",
  "code": "example"
}

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`

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

Включить DKIM подпись для домена

Обзор