Features Pricing Regions Support Start free Log in FR

Quickstart

Register a site, add a sitemap or feed, create a boost, and trigger your first run.

This guide walks you through warming your first cache end to end using the API.

Prerequisites

  • An API key with sites:write, boosts:write, and runs:read scopes (create one)
  • A domain you control
  1. Register your site
    curl -X POST https://api.cache-boost.com/v1/sites \
  -H "Authorization: Bearer cb_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "www.example.com"}'

    The response includes a validation_token. Add it to your server before proceeding.

  2. Allow CacheBoost traffic

    CacheBoost sends the X-CacheBoost-Token header on every warm-up request. If your site has a WAF, CDN, or rate limiter, create a rule that allows requests carrying this header.

    Find your token in the dashboard under My Sites → key icon. See Allow traffic for details.

  3. Add a sitemap or feed
    curl -X POST https://api.cache-boost.com/v1/sites/42/sitemaps \
  -H "Authorization: Bearer cb_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.example.com/sitemap.xml"}'

    Replace 42 with your site ID from step 1. Google Shopping feeds (RSS/Atom) are also accepted as URL sources.

  4. Create a boost
    curl -X POST https://api.cache-boost.com/v1/sites/42/boosts \
  -H "Authorization: Bearer cb_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Full site warm",
    "source": "sitemap",
    "concurrency": 3
  }'
  5. Run the boost
    curl -X POST https://api.cache-boost.com/v1/sites/42/boosts/1/run \
  -H "Authorization: Bearer cb_live_YOUR_KEY"

    The response includes a run_id. Poll GET /v1/runs/{runId} to check progress.

Next steps