List sitemaps

Returns all top-level sitemaps for a site. Child sitemaps (from sitemap indexes) are not included.

GET /v1/sites/{id}/sitemaps

Requires scope: sites:read

Path parameters

Parameter	Type	Required	Description
`id`	integer	Required	Site ID.

Example request

curl https://api.cache-boost.com/v1/sites/42/sitemaps \
  -H "Authorization: Bearer cb_live_YOUR_KEY"

Response

Returns 200 OK with an array of sitemap objects.

[
  {
    "id": 7,
    "url": "https://www.example.com/sitemap.xml",
    "status": "ready",
    "status_message": null,
    "last_processed_at": "2025-01-15T02:00:00Z",
    "created_at": "2025-01-10T09:00:00Z"
  }
]

Status values

Value	Description
`waiting`	Queued for download.
`downloading`	Currently downloading the sitemap file.
`parsing`	Extracting URLs from the sitemap.
`ready`	Processed successfully — URLs are available.
`error`	Processing failed. See `status_message` for details.

Errors

Code	Description
`401`	Missing or invalid API key.
`403`	Insufficient scope or access denied.
`404`	Site not found.