Fonctionnalités Tarifs Régions Support Essai gratuit Connexion EN

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ètreTypeRequisDescription
id integer Requis Identifiant du boost.

Paramètres du corps

Tous les paramètres du corps sont optionnels. Incluez uniquement les champs à modifier.

ParamètreTypeDescription
namestringNom du boost.
regionarrayRégions cibles.
url_rootstringNe préchauffer que les URLs commençant par ce chemin.
exclude_extarrayExtensions de fichiers à ignorer.
variationsobjectVariations de préchauffage (user agents et langues).
sitemap_idsarrayIdentifiants des sitemaps à préchauffer.
content_typesarrayTypes de contenu à cibler.
schedulestring|nullExpression cron (UTC). Mettre à null pour supprimer la planification.
call_limitinteger|nullNombre maximum d'appels. Mettre à null pour supprimer la limite.
ignore_errorsbooleanSi true, le boost ne se met pas en pause automatiquement en cas de taux d'erreur élevé.
report_email_enabledbooleanEnvoyer 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

CodeDescription
401Clé API manquante ou invalide.
403Scope insuffisant ou accès refusé.
404Boost introuvable.
409Le boost a un run en cours — modification impossible.
422Erreur de validation — valeurs de champs invalides.