Create Purge
This API is used to create batch purge on edge server.It is prefix based, i.e. it's possible to invalidate everything under a directory, or with different extensions, etc.content is physically removed only when it is accessed, i.e. proxy checks if the path matches the invalidation prefix, and if it does and the content is in the cache then it is invalidated. If some content is not accessed in 24h (validity period for invalidation request) then stale content can remain on the cache / be served.
1. Request Definition
- API URL
https://cdn-api.swiftfederation.com/v2.0/services/{serviceId}/purges
- Request Method
POST
- Request Header
Refer to HTTP Request Headers
- Request Body
Request Body Data Format: JSON, an array of the following objects. And the length of the array should be less than 20k. Every service has its own limits which are checked each time when creating a new request. Every service has limits on number of URLs that can be purged in a specific time interval. The default limits: 150 URLs per 5 minutes, 450 URLs per an hour, 1000 URLs per a day. These limits can be changed per service, if you would like that to be done for some service please contact support.
Field | Required | Type | Description |
---|---|---|---|
urlPath | Mandatory | string | Url path to be purged on edge server. |
expireTimestamp | Mandatory | long | UTC timestamp before which contents should be expired. |
- Request Body Example
[
{
"urlPath": "/resources/js/test1.js",
"expireTimestamp": 1405005161
},
{
"urlPath": "/resources/js/test2.js",
"expireTimestamp": 1405005161
}
]
2. Response Definition
- Response Header
Refer to HTTP Response Headers
- Response Body
Field | Type | Description |
---|---|---|
batchId | int | the id of batch purge |
- Response Body Example
{
"batchId": 2
}