Getting the list of Sitemap files added by the user

Returns the list of Sitemap files added by the user.

  1. Request format
  2. Response format
  3. Response codes

Request format

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/user-added-sitemaps
 ? [offset=<sitemap id>]
 & [limit=<int 32>]
Path parameters
user-idType: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
host-idType: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.
Path parameters
user-idType: int64. User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /v4/user method.
host-idType: host id (string). The site ID. To get it, use the GET /v4/user/{user-id}/hosts method.
Query parameters
offsetGet files starting from the specified one (not including it). Default value: 0.
limitPage size (1-100). Default value: 100.
Query parameters
offsetGet files starting from the specified one (not including it). Default value: 0.
limitPage 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
}
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.
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."
}
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"
}
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."
}
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"
}