Modifier un boost
Met à jour la configuration d'un boost. Tous les champs sont optionnels — indiquez uniquement ce que vous souhaitez modifier. Retourne 409 si le boost a un run en cours.
PUT
/v1/boosts/{id}
Scope requis : boosts:write
Paramètres de chemin
| Paramètre | Type | Requis | Description |
|---|---|---|---|
id |
integer | Requis | Identifiant du boost. |
Paramètres du corps
Tous les paramètres du corps sont optionnels. Incluez uniquement les champs à modifier.
| Paramètre | Type | Description |
|---|---|---|
name | string | Nom du boost. |
region | array | Régions cibles. |
url_root | string | Ne préchauffer que les URLs commençant par ce chemin. |
exclude_ext | array | Extensions de fichiers à ignorer. |
variations | object | Variations de préchauffage (user agents et langues). |
sitemap_ids | array | Identifiants des sitemaps à préchauffer. |
content_types | array | Types de contenu à cibler. |
schedule | string|null | Expression cron (UTC). Mettre à null pour supprimer la planification. |
call_limit | integer|null | Nombre maximum d'appels. Mettre à null pour supprimer la limite. |
ignore_errors | boolean | Si true, le boost ne se met pas en pause automatiquement en cas de taux d'erreur élevé. |
report_email_enabled | boolean | Envoyer un rapport par email à la fin d'un run. |
Exemple de requête
curl -X PUT https://api.cache-boost.com/v1/boosts/15 \
-H "Authorization: Bearer cb_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"schedule": "0 3 * * *", "region": ["fr", "eu"]}'
Réponse
Retourne 200 OK avec l'objet boost mis à jour.
Erreurs
| Code | Description |
|---|---|
401 | Clé API manquante ou invalide. |
403 | Scope insuffisant ou accès refusé. |
404 | Boost introuvable. |
409 | Le boost a un run en cours — modification impossible. |
422 | Erreur de validation — valeurs de champs invalides. |