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

Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.

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

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

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

POST https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/
Content-type: application/xml

Path-параметры


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


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

Пример

{
  "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`	ID добавленного сайта.

Коды ответа

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


Код	Причина	Описание
201	CREATED	Сайт добавлен в список пользователя.
403	HOSTS_LIMIT_EXCEEDED	Превышен лимит количества сайтов в списке сайтов пользователя (текущий лимит — 1703). JSON XML `{ "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-токена. JSON XML `{ "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	Сайт с таким именем уже добавлен в список сайтов пользователя. JSON XML `{ "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>`


Код	Причина	Описание
201	CREATED	Сайт добавлен в список пользователя.
403	HOSTS_LIMIT_EXCEEDED	Превышен лимит количества сайтов в списке сайтов пользователя (текущий лимит — 1703). JSON XML `{ "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-токена. JSON XML `{ "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	Сайт с таким именем уже добавлен в список сайтов пользователя. JSON XML `{ "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>`