Добавление сайта

Добавляет сайт в список сайтов пользователя.

Формат запроса

POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

В теле запроса укажите имя нового сайта, а также требуемый тип данных в заголовке Content-type (application/json или application/xml).

Пример

{
  "host_url": "http://example.com"
}

<Data>
    <host_url>http://example.com</host_url>
</Data>

Параметр

Описание

host_url

URI добавляемого сайта.

Формат ответа

Пример

{
  "host_id": "http:example.com:80"
}

<Data>
    <host_id>http:example.com:80</host_id>
</Data>

Параметр

Обязательный

Тип

Описание

host_id

Да

host id (string)

ID добавленного сайта.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код

Причина

Описание

201

CREATED

Сайт добавлен в список пользователя.

403

HOSTS_LIMIT_EXCEEDED

Превышен лимит количества сайтов в списке сайтов пользователя (текущий лимит — 1703).

{
 "error_code": "HOSTS_LIMIT_EXCEEDED",
 "limit": 1,
 "error_message": "explicit error message"
}

<Data>
  <error_code>HOSTS_LIMIT_EXCEEDED</error_code>
   <limit>1</limit>
   <error_message>explicit error message</error_message>
</Data>

403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}

<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

409

HOST_ALREADY_ADDED

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

{
  "error_code": "HOST_ALREADY_ADDED",
  "host_id": "http:ya.ru:80",
  "verified": false,
  "error_message": "some string"
}

<Data>
  <error_code>HOST_ALREADY_ADDED</error_code> 
  <host_id>http:ya.ru:80</host_id> 
  <verified>false</verified> 
  <error_message>some string</error_message>
</Data>

Узнайте больше

Предыдущая
Получение списка сайтов пользователя
Следующая
Удаление сайта