Purge

The azion/purge module is the Azion Lib library for Real-Time Purge. Its functions remove URLs, cache keys, and wildcard expressions from the cache through Azion API v4, so the next request fetches the current version from the origin. Each function takes a list of strings and returns a response envelope instead of throwing.

Install the package:

The azion package receives bug fixes only, and its maintenance ends in December 2026.

Every sample below is a TypeScript ES module with top-level await, run in Node.js. Types come in through import type, so the sample still loads after its type annotations are stripped.

Authentication

Each purge request carries your personal token. The functions take it from the AZION_TOKEN environment variable, and a createClient client takes it from its token field.

To see where each Azion Lib package looks for these values, refer to How Azion Lib works.

Response envelope

Every function returns an AzionPurgeResponse object, { data?, error? }. On success, data holds an AzionPurge object: items, the list the purge received, and state. On failure, error holds { message, operation }, and operation is post purge.

Each function sends one request to Azion API v4. The API answers with the items and the layer it purged, and the envelope keeps only items and state:

The functions take no layer argument, and the API reports layer: 'cache' in its response. For the layers and the number of items each purge type accepts, refer to Real-Time Purge.

createClient

Creates a client that holds a token and exposes the three purge functions as methods.

Returns an AzionPurgeClient. Its methods take the same list as the matching function on this page, without options. To log the response the API returns, pass { debug: true } to a function, as the purgeURL sample does.

This sample creates a client and purges one URL with it:

Output:

purgeURL

Purges a list of URLs from the cache. Only the URLs in the list leave the cache.

Returns data as an AzionPurge object with the purged URLs in items. A URL whose host belongs to no domain of your account returns error; the message is in Errors.

This sample purges one URL in debug mode, so the output starts with the API response:

Output:

purgeCacheKey

Purges a list of cache keys from the cache. A cache key names one variation of a cached object.

Returns data as an AzionPurge object with the purged keys in items. A key carries no scheme: the host/path form is accepted, and a key that starts with a scheme, such as http://, is refused with error. For the format of a key, refer to Cache keys.

This sample purges one cache key in debug mode:

Output:

purgeWildCard

Purges the cached objects that match a wildcard expression: a URL with an asterisk (*) in the path or in the query string.

Returns data as an AzionPurge object with the expression in items. The type takes a list, and Real-Time Purge accepts one wildcard expression per request. For the expressions it accepts, refer to Wildcard purge.

This sample purges every cached object under one path prefix:

Output:

Errors

A refused purge returns error with the HTTP status only. The reason the API gives, such as The Content must be a valid cachekey., does not reach the envelope. error.operation is post purge for every function.

For the error codes the API returns for each purge type, refer to Real-Time Purge.

Types

The azion/purge module exports these types. Import them with import type.

AzionPurgeClient

The object createClient returns, with one method per purge type. Each method takes one list.

CreateAzionPurgeClient

The type of createClient.

AzionClientOptions

Request options that every function takes in options.

AzionPurgeResponse

The object each purge function returns. Response envelope describes the success and failure forms.

AzionPurge

The result of a purge.

Related resources