# API overview — CacheBoost Docs

> Base URL, authentication, response format, errors, and pagination.

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

---



Base URL, authentication, response format, errors, and pagination.

OpenAPI spec: https://www.cache-boost.com/openapi.yaml

## Base URL

```
https://api.cache-boost.com/v1
```

## Authentication

Pass your API key as a Bearer token in every request:

```
Authorization: Bearer cb_live_YOUR_KEY
```

See: https://www.cache-boost.com/support/getting-started/authentication

## Response format

All responses are JSON. Single resources return the object directly; collections return an array.

Paginated endpoints (e.g. `GET /runs`) wrap results:

```json
{
  "data": [ ... ],
  "limit": 20,
  "offset": 0
}
```

## Errors

```json
{ "error": "Invalid or expired API key." }
```

| HTTP status | Meaning |
|-------------|---------|
| `401` | Missing or invalid API key |
| `403` | Key lacks the required scope |
| `404` | Resource not found |
| `409` | Conflict (boost already running, duplicate sitemap) |
| `422` | Validation error |
| `500` | Server error |

## Pagination

`GET /runs` accepts `limit` (default: 20, max: 100) and `offset` query parameters:

```
GET /v1/runs?limit=50&offset=100
```

## Available endpoints

### Sites
- `GET /v1/sites` — https://www.cache-boost.com/support/api-reference/sites/list
- `POST /v1/sites` — https://www.cache-boost.com/support/api-reference/sites/create
- `GET /v1/sites/{siteId}` — https://www.cache-boost.com/support/api-reference/sites/get
- `DELETE /v1/sites/{siteId}` — https://www.cache-boost.com/support/api-reference/sites/delete
- `POST /v1/sites/{siteId}/validate` — https://www.cache-boost.com/support/api-reference/sites/validate

### Sitemaps
- `GET /v1/sites/{siteId}/sitemaps` — https://www.cache-boost.com/support/api-reference/sitemaps/list
- `POST /v1/sites/{siteId}/sitemaps` — https://www.cache-boost.com/support/api-reference/sitemaps/create
- `DELETE /v1/sites/{siteId}/sitemaps/{sitemapId}` — https://www.cache-boost.com/support/api-reference/sitemaps/delete

### Boosts
- `GET /v1/sites/{siteId}/boosts` — https://www.cache-boost.com/support/api-reference/boosts/list
- `POST /v1/sites/{siteId}/boosts` — https://www.cache-boost.com/support/api-reference/boosts/create
- `GET /v1/sites/{siteId}/boosts/{boostId}` — https://www.cache-boost.com/support/api-reference/boosts/get
- `PATCH /v1/sites/{siteId}/boosts/{boostId}` — https://www.cache-boost.com/support/api-reference/boosts/update
- `DELETE /v1/sites/{siteId}/boosts/{boostId}` — https://www.cache-boost.com/support/api-reference/boosts/delete
- `POST /v1/sites/{siteId}/boosts/{boostId}/run` — https://www.cache-boost.com/support/api-reference/boosts/run

### Runs
- `GET /v1/runs` — https://www.cache-boost.com/support/api-reference/runs/list
- `GET /v1/runs/{runId}` — https://www.cache-boost.com/support/api-reference/runs/get



---

**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