Sitemaps

You can list your sitemaps and download the corresponding xml file any time through our API.

List Sitemaps

GET https://sitemap.sh/api/sitemaps

This endpoint allows you to list your generated sitemap files.

Headers

Name	Type	Description
Authorization	string	Include your bearer token in this request.

200 Cake successfully retrieved.

{
  "sitemaps": [
    {
      "id": 7,
      "uuid": "ioaci2u83u2re98fd",
      "filename": "mxjdu9i273dc_2019_06_17_15_34_07.xml",
      "project_id": 1,
      "created_at": "yyyy-mm-dd h:m:s",
      "updated_at": "yyyy-mm-dd h:m:s",
      "project": {
        // The project details, including locations
      }
    }
  ]  
}

Download a Sitemap

GET https://sitemap.sh/api/:uuid

This endpoint will provide the XML contents of a specific sitemap file. You can then store it in your local web directory and proceed to send it to the search engines.

Path Parameters

Name	Type	Description
uuid	string	The uuid to identify the specific sitemap you want to download.

200

<?xml version="1.0" encoding="UTF-8"?>
<urlset
  xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
  xmlns:xhtml="http://www.w3.org/1999/xhtml">
  <url>
    <loc>https://www.example.com/</loc>
    <lastmod>2019-06-17T15:33:47+00:00</lastmod>
    <changefreq>daily</changefreq>
    <priority>0.8</priority>
  </url>
  <url>
    <loc>https://www.example.com/contact-us</loc>
    <lastmod>2019-06-17T15:33:47+00:00</lastmod>
    <changefreq>daily</changefreq>
    <priority>0.8</priority>
  </url>
  <url>
    <loc>https://www.example.com/knowledgebase</loc>
    <lastmod>2019-06-17T15:33:47+00:00</lastmod>
    <changefreq>daily</changefreq>
    <priority>0.8</priority>
  </url>
</urlset>

This endpoint is not protected. You can easily access your sitemaps from any location, without an API token. So be careful with your sitemaps's uuid's, as it is the only information needed to request your generated sitemap file.