List boosts

Returns all boosts belonging to the authenticated user.

GET /v1/boosts

Requires scope: boosts:read

Example request

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

Response

Returns 200 OK with an array of boost objects.

[
  {
    "id": 15,
    "site_id": 42,
    "name": "Daily warm",
    "status": "pending",
    "source_type": "sitemap",
    "region": ["fr"],
    "schedule": "0 1 * * *",
    "next_run_at": "2025-01-16T01:00:00Z",
    "created_at": "2025-01-10T09:00:00Z"
  }
]

Status values

Value	Description
`pending`	Waiting to be scheduled or triggered.
`running`	A run is currently in progress.
`paused`	Boost is paused (manually or due to high error rate).
`done`	Last run completed successfully.
`failed`	Last run failed.

Errors

Code	Description
`401`	Missing or invalid API key.
`403`	Insufficient scope.