PRpressable
sites

Cache Preload Status

Changed on

Get whether Cache Preload is on for a site, how far the current crawl has got, and any warnings that apply.

get/sites/{id}/cache-preload

Request

Path parameters

idinteger required

Response

Successful Response

messagestring
dataobject

Example response

{
  "message": "Success",
  "data": {
    "enabled": true,
    "state": "running",
    "urls_preloaded": null,
    "urls_found": 42,
    "searching": true,
    "warnings": [
      {
        "code": "small_site",
        "message": "This site has 5 or fewer PHP workers. While Cache Preload runs, especially after a full cache purge, it can push the site into burst or slow it down. Watch the site's usage, or add PHP workers."
      }
    ]
  }
}

Changes