Get Purge request List - GET /api/purge

Parent Previous Next

GET /api/purge                              

Get a list of purge requests that have been submitted.  Request parameters allow you to specify when the requests were made as well as the URL to match on.


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 Parameters

Parameter

Description

Required

datefrom

RFC3339 formatted date indicating the starting date. Example: 2013-01-01T22:30:00+08:00

No

dateto

RFC3339 formatted date indicating the ending date. Example: 2013-01-01T22:30:00+08:00

No

url

An encoded URL to match on.

No


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?datefrom = {date from} & dateto = {date to} & url = {encoded url}

-X GET

-u {user}: {password}

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

-H 'Accept: application/xml'


Sample Request:


The following asks for a list of all purge requests.


curl -i --url 'https://api.quantil.com/api/purge' -X GET -u test:qawuYz8sck6j928sid9Zb10WaIs= -H 'Date: Thu, 07 Aug 2014 09:59:09 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}



Response Body Elements

Element

Description

purge-list

container for purge request information. This contains 0 or more <Purge-request> elements.

Purge-request

container for information about a specific purge request. It contains the following child elements: <Purge-id>, <Request-date>, and <item>

Purge-id

unique id representing a purge request

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. "100.0" represents a purge that has completed 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 16:59:08 GMT

Accept-Ranges: bytes

Server: WS-web-server

x-cnc-request-id: 1127619

ContentType: application/xml;charset=UTF-8

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

Content-Length: 5046


<purge-list>

 <purge-request>

   <purge-id>11985dbb-9b9e-4389-915d-80139affb4ba</purge-id>

   <request-date>Thu, 26 Jun 2014 13:52:15 CDT</request-date>

   <item>

     <path>http://testaccount.com/mydir2</path>

     <status>success</status>

     <rate>100.0</rate>

     <isdir>Y</isdir>

   </item>

 </purge-request>

 <purge-request>

   <purge-id>24fc9ce2-7af5-417f-b532-bdd6701f1d15</purge-id>

   <request-date>Sat, 12 Jul 2014 18:45:26 CDT</request-date>

   <item>

     <path>http://test2.com/aa</path>

     <status>success</status>

     <rate>100.0</rate>

     <isdir>Y</isdir>

   </item>

 </purge-request>

<purge-request>

   <purge-id>c5034d43-0d5a-45a1-8fbe-9f06fa286b05</purge-id>

   <request-date>Thu, 07 Aug 2014 11:41:50 CDT</request-date>

   <item>

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

     <status>success</status>

     <rate>100.0</rate>

     <isdir>N</isdir>

   </item>

   <item>

     <path>http://mynewtestdomain1.com/mydir</path>

     <status>success</status>

     <rate>100.0</rate>

     <isdir>Y</isdir>

   </item>

 </purge-request>

</purge-list>

Error List

This API has no special error codes.