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

NameRequiredTypeDefault valueDescription
user-idYesint64The user ID.
host-idYeshost idSite ID.

Query arguments

NameRequiredTypeDefault valueDescription
OffsetNositemap id0Get sitemaps, starting from the specified one (not including it).
LimitNoint32100Page 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
}
NameRequiredTypeDescription
sitemap_idYesstringID of the sitemap file.
sitemap_urlYesstringURL of the sitemap file.
added_dateYesyyyy-MM-ddTHH:mm:ss,sssZThe date the file was added.
countYesint32The 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."
}
ParameterDescription
error_codeError code.
available_user_idID of the user who allowed access.
error_messageError 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"
}
ParameterDescription
error_codeError code.
host_idThe ID of the requested site.
error_messageError message.