Authorizations
API key for authentication. Make sure to include the word apikey
, followed by a single space and then your token.
Example: apikey 1234$abcdef
Query Parameters
Purges associated with a specific resource CNAME.
Example: * &cname=example.com
Purge with a certain status.
Possible values:
- In progress
- Successful
- Failed
- Status report disabled
Purge requests with a certain purge type.
Possible values:
purge_by_pattern
- Purge by Pattern.purge_by_url
- Purge by URL.purge_all
- Purge All.
Start date and time of the requested time period (ISO 8601/RFC 3339 format, UTC.)
Examples:
* &from_created
=2021-06-14T00:00:00Z
* &from_created
=2021-06-14T00:00:00.000Z
End date and time of the requested time period (ISO 8601/RFC 3339 format, UTC.)
Examples:
* &to_created
=2021-06-15T00:00:00Z
* &to_created
=2021-06-15T00:00:00.000Z
Number of purge requests in the response to skip starting from the beginning of the requested period.
Maximum number of purges in the response.
x <= 100
Response
Successful.
Purge ID.
1
Purge status.
Possible values:
- In progress - Purge is in progress.
- Successful - Purge was successful.
- Failed - Purge failed.
In progress
, Successful
, Failed
Purge payload depends on purge type.
Possible values:
- urls - Purge by URL.
- paths - Purge by Pattern and purge All.
Date and time when the purge was created (ISO 8601/RFC 3339 format, UTC).
"2021-10-29T13:21:01.550849Z"
Contains the name of the purge request type.
Possible values:
purge_by_pattern
- Purge by Pattern.purge_by_url
- Purge by URL.purge_all
- Purge All.
"purge_by_url"