Utiliser les APIs d'invalidation de cache

Fonctionnalités

Un utilisateur Baleen peut :

Pré requis : Pour utiliser cette API, il sera nécéssaire d'avoir récupérer un PAT, un namespace ciblé et le cookie de session. (Voir documentation Général API)

Invalidation de ressources

L'invalidation de ressource permet de supprimer cette ressource du cache à un instant T : à la prochaine requête, Baleen ira chercher la ressource directement à l’origine puis la remettra en cache si cette ressource était dans la liste à cacher.

Pour invalider une ou plusieurs ressources il faut appeler le endpoint suivant en méthode POST : /api/cache/invalidations

curl -X POST https://console-preprod.baleen.cloud/api/cache/invalidations 
-H "X-Api-Key: <PAT>" 
-H 'Content-Type: application/json'
--cookie "baleen-namespace=<namespace-key>"
--data-raw'{ 
"patterns": [ 
     "https://domain.com/my/resource.png",
     "/my/[0123]/pattern/.png"
   ] 
}'

Tips 1 : Penser à passer le header X-Api-Key: <PAT>
Tips 2 : Penser à renseigner le cookie pour cibler le namespace voulu

Le modèle de requête à fournir pour le body :

{ 
   "patterns": [ 
      <string>, 
      <string>, 
      ... 
   ] 
}

<string> peut être sous la forme de :

Pattern au format PCRE.
URL pointant vers une ressource

Cas de retours

Les différents cas de retour possible :

200 :
- Invalidation valide (traitement de l’invalidation démarré)
400 :
- Format du body incorrect
- Certaines entrées d'invalidation ne sont pas au bon format. Dans la réponse une propriété ‘notCompliantPatterns’ est un tableau listant les entrée invalides.
500 :
- Erreur serveur d’invalidation, contacter le support si l’erreur persiste

--> Swagger doublon voir

Exemples

Exemple 1 : Je veux invalider toutes les ressources

{ 
   patterns: [ 
      “.” 
   ] 
}

Exemple 2 : Je veux invalider un lot de ressources

Exemple : J’invalide un pattern qui n’est pas PCRE

Réponse 400 => une entrée est ciblée comme n’étant pas valide