Adding a site
Adds the site to the user's site list.
Request format
POST https://api.webmaster.yandex.net/v4/user/{user-id}/hosts
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
user-id | Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method. |
In the request body, specify the new site name and the desired data type in the Content-type
header (application/json
or application/xml
):
Example
Parameter | Description |
---|---|
host_url | URI of the site to add. |
Parameter | Description |
---|---|
host_url | URI of the site to add. |
Response format
Example
Parameter | Required | Type | Description |
---|---|---|---|
host_id | Yes | host id (string) | ID of the added site. |
Parameter | Required | Type | Description |
---|---|---|---|
host_id | Yes | host id (string) | ID of the added site. |
Response codes
To view the response structure in detail, click the reason.
Code | Reason | Description |
---|---|---|
201 | CREATED | The site was added to the user's list. |
403 | HOSTS_LIMIT_EXCEEDED | The number of sites in the user's site list exceeded the limit (the current limit is 1703). |
The ID of the user who issued the token differs from the one specified in the request. In the examples below, | ||
409 | HOST_ALREADY_ADDED | A site with this name was already added to the user's site list. |
Code | Reason | Description |
---|---|---|
201 | CREATED | The site was added to the user's list. |
403 | HOSTS_LIMIT_EXCEEDED | The number of sites in the user's site list exceeded the limit (the current limit is 1703). |
The ID of the user who issued the token differs from the one specified in the request. In the examples below, | ||
409 | HOST_ALREADY_ADDED | A site with this name was already added to the user's site list. |