Getting a list of sitemaps added by the user

Description

Gets a list of sitemap files added by the user.

Request format

Send a GET request to the operation address for the user-added-sitemaps resource for the user's site:

GET https://api.webmaster.yandex.net/v3/user/{user-id}/hosts/{host-id}/user-added-sitemaps/[?offset={offset}&limit={limit}]

Path parameters

Name Required Type Default value Description
user-id Yes int64 The user ID.
host-id Yes host id Site ID.

Query arguments

Name Required Type Default value Description
Offset No sitemap id 0 Get sitemaps, starting from the specified one (not including it).
Limit No int32 100 Page size (1-100).

Response format

If successful, the server returns 200 OK and a list of the user's sitemap files.

Samples

{
  "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 ID of the sitemap file.
sitemap_url Yes string URL of the sitemap file.
added_date Yes yyyy-MM-ddTHH:mm:ss,sssZ The date the file was added.
count Yes int32 The total number of sitemap files added by the user.

Errors

403 Forbidden

The user ID for the token doesn't match the one specified in the request. In the examples below, {user_id} is the correct uid for the owner of the OAuth token.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
Parameter Description
error_code Error code.
available_user_id ID of the user who allowed access.
error_message Error message.

404 Not Found

The site isn't in the list of the user's sites, or rights to the site haven't been verified.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "explicit error message"
}
Parameter Description
error_code Error code.
host_id The ID of the requested site.
error_message Error message.