Cache Invalidierungs-API

Die Cache Invalidierungs-API bietet eine Reihe Aufrufe zur Verwaltung und Aktualisierung zwischengespeicherter Inhalte, um sicherzustellen, dass Anwendungen deinen Benutzern immer die aktuellsten und relevantesten Daten liefern.

Cloudflare

Bei der Verwendung von Cloudflare muss eine zusätzliche WAF Regel erstellt werden, um sicherzustellen, dass BAN, oder PURGE Requests von Cloudflare nicht geblockt werden. Mehr Infos zur Konfiguration der WAF Regel wird im Cloudflare Setup beschrieben.

Allgemeine Informationen zu allen API Calls

Als Methode für die Cacheinvalidierung können die Methoden BAN und PURGE verwendet werden und verhalten sich identisch. Die Methoden müssen abhängig des verwendeten Frameworks oder zusätzlicher Software (wie Cloudflare) gewählt werden. In der Regel kann BAN verwendet werden.

Flush-URL

Der Aufruf "Flush-URL" ermöglicht das leeren des Caches einer bestimmten URL im Cache. Egal, ob die Startseite oder eine bestimmte Ressource aktualisiert werden muss, dieser API-Aufruf stellt sicher, dass die neueste Version des Inhalts vom Ursprungsserver abgerufen wird. Die Anfrage kann wie folgt verwendet werden:

curl -X BAN -H "secret: <Token>" -H "url: /" https://www.beispiel.com/
# ODER
curl -X BAN -H "secret: <Token>" https://www.beispiel.com/url_zur_Invalidierung

Flush-File

Der Aufruf "Flush-File" ist für Fälle gedacht, in denen bestimmte Datein im Cache ungültig gemacht werden müssen. Dies ist besonders nützlich für statische Ressourcen wie HTML-, CSS- oder JavaScript-Dateien. Der Aufruf ermöglicht es, sicherzustellen, dass eine bestimmte Datei immer frisch vom Ursprungsserver abgerufen wird. Die Anfrage kann wie folgt verwendet werden:

curl -X BAN -H "secret: <Token>" -H "cache-file: 469640790ad5bda4d1cc6a19f6770214.html" https://www.beispiel.com/

Der Hash der Cache Datei wird als Antwort-Header zurückgeliefert, sollte die Option Debug-Header aktiviert sein.

Flush-Tags

Flush-Tags ist eine Funktion des Cache-Managements, mit der bestimmte Tags mit zwischengespeicherten Inhalten verknüpft werden können. Diese Tags werden mithilfe des HTTP-Headers x-cache-tags erstellt und verwaltet. Wenn Inhalte im Zusammenhang mit bestimmten Tags ungültig gemacht werden müssen, ermöglicht dieser Aufruf dies effizient. Zum Beispiel:

curl -X BAN -H "secret: <Token>" -H "tags: foo" https://www.beispiel.com/
# Tags werden über den Header "x-cache-tags: foo, bar" erstellt.

Sollen mehrere Tags gelöscht werden kann ein Request mit einer Liste an Tags übermittelt werden. Die Tags werden dabei mit Komma separiert übergeben.

curl -X BAN -H "secret: <Token>" -H "tags: foo,bar" https://www.beispiel.com/

Anwendungsfälle und Ideen zur Verwendung von Flush-Tags können in den Best Practices nachgelesen werden.

Flush-All

In bestimmten Szenarien muss möglicherweise der gesamten Cache geleert werden. Der Aufruf "Flush-All" bietet eine Möglichkeit, alle zwischengespeicherten Inhalte zu löschen und mit den Daten des Ursprungsservers von vorne zu beginnen. Die Anfrage kann wie folgt verwenden werden:

curl -X BAN -H "secret: <Token>" -H "type: flushall" https://www.beispiel.com/