Adding a Sitemap file

Adds the Sitemap file to Yandex.Webmaster.

Request format

In the request body, pass the Sitemap file URL and specify the desired data type in the Content-type header (application/json or application/xml):

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

user-id

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

host-id

Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

Example

{
  "url": "http://example.com"
}
<Data>
    <url>http://example.com</url>
</Data>

Parameter

Description

url

URL of the Sitemap file to add.

Response format

Examples

{
  "sitemap_id": "c7-fe:80-c0"
}
<Data>
    <sitemap_id>c7-fe:80-c0</sitemap_id>
</Data>

Name

Required

Type

Description

sitemap_id

Yes

string

ID of the added Sitemap file.

Response codes

To view the response structure in detail, click the reason.

Code

Reason

Description

201

CREATED

403

INVALID_USER_ID

The ID of the user who issued the token differs from the one specified in the request. In the examples below, {user_id} shows the correct uid of the OAuth token owner.

{   
    "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>

404

HOST_NOT_VERIFIED

Site management rights are not verified.

{   
    "error_code": "HOST_NOT_VERIFIED",   
    "host_id": "http:ya.ru:80",   
    "error_message": "some string" 
}
<Data>   
    <error_code>HOST_NOT_VERIFIED</error_code>     
    <host_id>http:ya.ru:80</host_id>   
    <error_message>some string</error_message> 
</Data>

409

SITEMAP_ALREADY_ADDED

The Sitemap was already added.

{   
    "error_code": "SITEMAP_ALREADY_ADDED",   
    "sitemap_id": "c7-fe:80-c0",   
    "error_message": "some string" 
}
<Data>   
    <error_code>SITEMAP_ALREADY_ADDED</error_code>    
    <sitemap_id>c7-fe:80-c0</sitemap_id>     
    <error_message>some string</error_message> 
</Data>

Type: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.

Type: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.

Description

URL of the Sitemap file to add.

Required

Yes

Type

string

Description

ID of the Sitemap file.

Description

Error code.

Description

ID of the user who allowed access.

Description

ID of the requested site.

Description

Error message.