const apiInstance = new Fastly.PurgeApi();
Method | Fastly API endpoint | Description |
---|---|---|
bulkPurgeTag | POST /service/{service_id}/purge | Purge multiple surrogate key tags |
purgeAll | POST /service/{service_id}/purge_all | Purge everything from a service |
purgeSingleUrl | GET /* | Purge a URL |
purgeTag | POST /service/{service_id}/purge/{surrogate_key} | Purge by surrogate key tag |
bulkPurgeTag({ service_id, [fastly_soft_purge, ][surrogate_key, ][purge_response] })
Instant Purge a particular service of items tagged with surrogate keys. Up to 256 surrogate keys can be purged in one batch request. As an alternative to sending the keys in a JSON object in the body of the request, this endpoint also supports listing keys in a Surrogate-Key
request header, e.g. Surrogate-Key: key_1 key_2 key_3
.
const options = {
service_id: "service_id_example", // required
fastly_soft_purge: 1,
surrogate_key: key_1 key_2 key_3,
purge_response: {"surrogate_keys":["key_1","key_2","key_3"]},
};
apiInstance.bulkPurgeTag(options)
.then((data) => {
console.log(data, "API called successfully.");
})
.catch((error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
service_id | String | Alphanumeric string identifying the service. | |
fastly_soft_purge | Number | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible. | [optional] [defaults to 1] |
surrogate_key | String | Purge multiple surrogate key tags using a request header. Not required if a JSON POST body is specified. | [optional] |
purge_response | PurgeResponse | [optional] |
{String: String}
purgeAll({ service_id })
Instant Purge everything from a service. 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.
const options = {
service_id: "service_id_example", // required
};
apiInstance.purgeAll(options)
.then((data) => {
console.log(data, "API called successfully.");
})
.catch((error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
service_id | String | Alphanumeric string identifying the service. |
purgeSingleUrl({ host, [fastly_soft_purge] })
Instant Purge an individual URL.
const options = {
host: www.example.com, // required
fastly_soft_purge: 1,
};
apiInstance.purgeSingleUrl(options)
.then((data) => {
console.log(data, "API called successfully.");
})
.catch((error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
host | String | The hostname for the content you'll be purging. | |
fastly_soft_purge | Number | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible. | [optional] [defaults to 1] |
purgeTag({ service_id, surrogate_key, [fastly_soft_purge] })
Instant Purge a particular service of items tagged with a Surrogate Key. Only one surrogate key can be purged at a time. Multiple keys can be purged using a batch surrogate key purge request.
const options = {
service_id: "service_id_example", // required
surrogate_key: key_1, // required
fastly_soft_purge: 1,
};
apiInstance.purgeTag(options)
.then((data) => {
console.log(data, "API called successfully.");
})
.catch((error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
service_id | String | Alphanumeric string identifying the service. | |
surrogate_key | String | Surrogate keys are used to efficiently purge content from cache. Instead of purging your entire site or individual URLs, you can tag related assets (like all images and descriptions associated with a single product) with surrogate keys, and these grouped URLs can be purged in a single request. | |
fastly_soft_purge | Number | Optional header indicating that the operation should be a 'soft' purge, which marks the affected object as stale rather than making it inaccessible. | [optional] [defaults to 1] |