GET /api/purge/{purge-id}

Get the status of a specific purge request. The purge-id is returned when creating a new purge request.

Request Details

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

This request does not include an XML document in the request body.

Request Syntax:

GET /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/{purge-id}

-X GET

-u {user}: {password}

-H 'Date: Fri, 26 Oct 2012 06:33:26 GMT'

-H 'Accept: application/xml'

Sample Request:

curl -i --url 'https://api.quantil.com/api/purge/3315965a-41fc-4c72-a8ff-4c54e0a106f1' -X GET -u test:+pLjLtfBEd5ttYKx122vw18QVGI= -H 'Date: Thu, 07 Aug 2014 11:46:22 PDT' -H 'Accept: application/xml'

Response Details:

Response Headers:

HTTP/1.1 200 OK

Date: <date>

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

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

Content-Length: <length>

Response Body Elements

Element	Description
purge-result	container for purge request information. It contains a <request-date> element and an <item> element.
request-date	RFC1123 format date indicating when the request was made.
item	a container object which describe the details of a purge request. It will contain the following child elements: path, status, rate, and isdir.
path	path to a file or directory to be updated.
status	The value will be either wait, run, Success, or Failure indicating the status of the purge request.
rate	A completion rate specified as the percentage of QUANTIL cache servers that have been updated successfully.
isdir	Can be Y or N indicating if the purge request was a directory.

Sample Response:

HTTP/1.1 200 OK

Date: Thu, 07 Aug 2014 18:46:21 GMT

Accept-Ranges: bytes

Server: WS-web-server

x-cnc-request-id: 1128692

ContentType: application/xml;charset=UTF-8

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

Content-Length: 415

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

<request-date>Thu, 07 Aug 2014 18:46:21 GMT</request-date>

<item>

<path>http://mynewtestdomain1.com/1.txt</path>

<status>success</status>

</item>