POST /api/purge

Purge content in your domains. You can purge up to 500 directory URLs and 5000 file URLs per day.

Request Syntax

Request Headers

Header	Description	Required
Authorization	Authorization string for the request	Yes
Host	URI for the QUANTIL SDK (i.e., api.quantil.com)	Yes
Date	The date and time of the request.	Yes
Accept	Indicates the accepted format (i.e., application/xml)	Yes

Request Body Elements

Element	Description
purge-urls	Container object which describe the URLs to be purged. It should include a <version> child element and optionally a <file-url> child or a <dir-url> child.
version	a version string, i.e., 1.0.0
file-url	URL of a file to purge. The URL must include the domain. Example: http://quantil.com/test/a.htm
dir-url	URL of a directory to purge. The URL must include the domain. Subdirectories of the directory will also be purged.

Request Syntax:

POST /api/purge HTTP/1.1

Authorization: <authorization string>

Host: api.quantil.com

Date: <date>

Accept: application/xml

Here is the structure of a request using the curl utility.

curl -i --url https://api.quantil.com/api/purge

-X POST

-u {user}: {password}

-H 'Date: Thu, 17 May 2012 19:37:58 GMT'

-H 'Accept: application / xml'

-d '<?xml version = "1.0" encoding = "UTF-8"?>

<purge-urls>

<file-url> {your file URL including the domain name you want to purge} </file-url>

<dir-url> {your directory URL including the domain name you want to purge} </dir-url>

</purge-urls> '

Sample Request:

curl -i --url 'https://api.quantil.com/api/purge' -X POST -u ntest:hejdIfk9nqIvnhaX/1ltjyVdF58= -H 'Date: Thu, 07 Aug 2014 09:52:59 PDT' -H 'Accept: application/xml' -d '<?xml version="1.0" encoding="UTF-8"?> <purge-urls> <version>1.0.0</version> <file-url>http://mynewtestdomain1.com/1.txt</file-url> <dir-url>http://mynewtestdomain1.com/mydir</dir-url> </purge-urls>'

Response Details:

Response Headers:

HTTP / 1.1 202 Accepted

Date: <date>

Content-Type: application/xml; charset = utf-8

Location: https://api.quantil.com/api/purge/{purge-id}

x-cnc-request-id: {id string auto generated by the QUANTIL server}

The Location header will have a URL you can use to get the status of the purge request. Purge-id is a unique id.

Response Body Elements

Element	Description
response	container for additional information from the QUANTIL server.
message	a message returned by the QUANTIL server.

Sample Response:

HTTP/1.1 202 Accepted

Date: Thu, 07 Aug 2014 16:52:59 GMT

Accept-Ranges: bytes

Server: WS-web-server

x-cnc-request-id: 1127554

ContentType: application/xml;charset=UTF-8

Location: https://api.quantil.com/api/purge/8f653260-f4cb-4299-bcde-162e9cf11c24

Content-Type: application/xml;charset=UTF-8

Content-Length: 86

<?xml version="1.0" encoding="UTF-8"?>

<response><message>success</message></response>

Error List

Error	Description	HTTP status code
NoSuchDomain	The specified domain does not exist.	404

Create Purge Requests - POST /api/purge