Purging effectively removes an object from the Fastly cache, prompting future requests that would otherwise hit that cached object to proceed to origin as a cache miss.
In practice, while some types of purge do effectively delete content, others will mark the content as stale, allowing you to refresh caches more gracefully if desired. This kind of purge is called a soft purge (see soft vs. hard purge below).
Learn more about how purging works, including use cases and best practices, limitations, constraints, and performance in our dedicated purging overview.
By default, purging an object will make it immediately inaccessible to new requests. The data might not be removed from storage right away, but it will no longer be matched by any cache lookup and will eventually be evicted. This is a 'hard' purge.
For improved performance and to protect backend servers from being overloaded by an inrush of traffic following a purge, you can perform a 'soft' purge, which marks the affected object as stale rather than making it inaccessible. The presence of stale objects can reduce backend load by allowing for conditional revalidation and other performance-enhancing patterns. To learn more, read about using and revalidating stale content.
Single object, surrogate key, and bulk surrogate key purges all support soft purge. To make a purge soft, add the following HTTP request header when making the API request:
Purge-all requests cannot be done in soft mode and will always immediately invalidate all cached content associated with the service. To do a soft-purge-all, consider applying a constant surrogate key tag (e.g.,
"all") to all objects.
Instant Purging removes content from Fastly immediately so it can be refreshed from your origin servers. The main entry point for the API,
https://api.fastly.com/, is not needed for an individual URL Instant Purge.
Purge multiple surrogate key tags using a JSON POST body. Not required if the
Surrogate-Key header is specified.
|string||Alphanumeric string identifying a Purging. Read-only.|