Créer un boost

Crée une nouvelle campagne de préchauffage de cache.

POST /v1/boosts

Scope requis : boosts:write

Paramètres du corps

Paramètre	Type	Requis	Description
`name`	string	Requis	Nom du boost.
`site_id`	integer	Requis	Identifiant du site à préchauffer.
`source_type`	string	Requis	`sitemap` ou `csv`.
`region`	array	Requis	Régions cibles. Valeurs : `fr`, `us`, `eu`, `as`.
`sitemap_ids`	array	Optionnel	Requis si `source_type` est `sitemap`. Identifiants des sitemaps à préchauffer.
`source_url`	string	Optionnel	URL du fichier CSV. Requis si `source_type` est `csv`.
`url_root`	string	Optionnel	Ne préchauffer que les URLs commençant par ce chemin. Défaut : `/`.
`exclude_ext`	array	Optionnel	Extensions de fichiers à ignorer (ex. `jpg`, `png`, `css`, `js`).
`variations`	object	Optionnel	Variations de préchauffage avec `user_agents` (mobile, desktop, bot, ai_crawler) et `languages` (ex. fr-FR, en-US). Chaque combinaison compte comme un appel par URL.
`schedule`	string	Optionnel	Expression cron (UTC) pour la planification automatique.
`call_limit`	integer	Optionnel	Nombre maximum d'appels pour ce boost.
`ignore_errors`	boolean	Optionnel	Si `true`, le boost ne se met pas en pause automatiquement en cas de taux d'erreur élevé. Défaut : `false`.
`report_email_enabled`	boolean	Optionnel	Envoyer un rapport par email à la fin d'un run. Défaut : `true`.

Exemple de requête

curl -X POST https://api.cache-boost.com/v1/boosts \
  -H "Authorization: Bearer cb_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily warm",
    "site_id": 42,
    "source_type": "sitemap",
    "region": ["fr"],
    "sitemap_ids": [7],
    "schedule": "0 1 * * *"
  }'

Réponse

Retourne 201 Created avec l'objet boost complet.

{
  "id": 15,
  "site_id": 42,
  "name": "Daily warm",
  "status": "pending",
  "source_type": "sitemap",
  "region": ["fr"],
  "sitemap_ids": [7],
  "url_root": "/",
  "exclude_ext": null,
  "variations": null,
  "content_types": null,
  "ignore_errors": false,
  "report_email_enabled": true,
  "schedule": "0 1 * * *",
  "next_run_at": "2025-01-16T01:00:00Z",
  "call_limit": null,
  "created_at": "2025-01-15T10:30:00Z"
}

Erreurs

Code	Description
`401`	Clé API manquante ou invalide.
`403`	Scope insuffisant ou accès refusé.
`404`	Site ou sitemap introuvable.
`422`	Erreur de validation — champs manquants ou invalides.