# Warm URLs — CacheBoost API

> Trigger an on-demand cache warm for a list of URLs.

Source: https://www.cache-boost.com/support/api-reference/sites/warm.md
Language: en

---



Trigger an on-demand cache warm for a specific list of URLs. The response is `202 Accepted` — the run is queued and processed asynchronously.

**`POST /v1/sites/{id}/warm`** — Scope: `boosts:write`

## Body parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Required | List of URLs to warm. All URLs must belong to the site's domain. Maximum 5,000. |
| `region` | array | Optional | Target regions, e.g. `fr`, `de`, `es`, `gb`, `us` (`GET /v1/me` lists the available ones; `uk` is accepted as `gb`). Default: `["fr"]`. |
| `variations` | object | Optional | `user_agents` (mobile, desktop, bot, ai_crawler) and `languages`. Each combination counts as one call per URL. |

## Example request

```bash
curl -X POST https://api.cache-boost.com/v1/sites/42/warm \
  -H "Authorization: Bearer cb_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": ["https://www.example.com/", "https://www.example.com/about"], "region": ["fr", "us"]}'
```

## Response

`202 Accepted`

```json
{
  "run_id": 91,
  "url_count": 2,
  "status": "pending"
}
```

The site must be validated before warming. Use the returned `run_id` to poll `GET /v1/runs/{id}` for progress.
See: https://www.cache-boost.com/support/api-reference/runs/get

## Errors

| Code | Description |
|------|-------------|
| `401` | Missing or invalid API key |
| `403` | Insufficient scope, access denied, or quota exceeded |
| `404` | Site not found |
| `409` | Site is not validated, or a warm run is already in progress |
| `422` | Validation error — missing or invalid fields, or URLs outside the site's domain |



---

**CacheBoost** — Automatic cache warming for faster websites.

- Website: https://www.cache-boost.com
- Full content (all pages): https://www.cache-boost.com/llms-full.txt
- LLM index: https://www.cache-boost.com/llms.txt
- Documentation: https://www.cache-boost.com/support/getting-started/introduction
- Start free: https://www.cache-boost.com/try