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/v3.2/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 | User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method. | |
host-id | Yes | host id | The site ID. To get it, use the GET /user/{user-id}/hosts method. |
Name | Required | Type | Default value | Description |
---|---|---|---|---|
user-id | Yes | int64 | User ID. Required when calling all Yandex.Webmaster API resources. To get it, use the GET /user method. | |
host-id | Yes | host id | The site ID. To get it, use the GET /user/{user-id}/hosts method. |
Query parameters
Name | Required | Type | Default value | Description |
---|---|---|---|---|
offset | No | sitemap id | 0 | Get files starting from the specified one (not including it). |
limit | No | int32 | 100 | Page size (1-100). |
Name | Required | Type | Default value | Description |
---|---|---|---|---|
offset | No | sitemap id | 0 | Get files starting from the specified one (not including it). |
limit | No | int32 | 100 | Page size (1-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. |
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 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |
Code | Reason | Description |
---|---|---|
200 | OK | |
403 | The ID of the user who issued the token differs from the one specified in the request. In the examples below, | |
404 | HOST_NOT_VERIFIED | Site management rights are not verified. |