Getting the list of Sitemap files added by the user

Returns the list of Sitemap files added by the user.

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/user-added-sitemaps
  ? [offset=<sitemap id>]
  & [limit=<int 32>]

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.

offset

Get files starting from the specified one (not including it). Default value: 0.

limit

Page size (1-100). Default value: 100.

Response format

Examples

{
  "sitemaps": [
    {
      "sitemap_id": "c7-fe:80-c0",
      "sitemap_url": "some url",
      "added_date": "2016-01-01T00:00:00,000+0300"
    }, ...
  ],
  "count": 1
}

<Data>
  <sitemap>
        <sitemap_id>c7-fe:80-c0</sitemap_id>
        <sitemap_url>some url</sitemap_url>
        <added_date>2016-01-01T00:00:00,000+0300</added_date>
  </sitemap>
  ...
  <count>1</count>
</Data>

Name

Required

Type

Description

sitemap_id

Yes

string

The Sitemap file ID.

sitemap_url

Yes

string

The Sitemap URL.

added_date

Yes

datetime

Date the file was added.

count

Yes

int32

Total number of Sitemap files added by the user.

Response codes

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

Code

Reason

Description

200

OK

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>
Previous
Getting information about the Sitemap file
Next
Getting information about the Sitemap added by the user