Get Domain Deployment History - GET /api/domain/{domain-id}/history
Get a domain's deployment history. Domain-id is a unique id representing a domain. It is returned when you create a domain. This API can be called for domains of the Web Acceleration, Website Acceleration - Static only, Download Acceleration, and Video Acceleration products.
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 |
This request does not include an XML document in the request body.
GET /api/domain/<domain-id>/history HTTP/1.1
Authorization: Basic <authorization string>
Host: api.quantil.com
Date: <date>
Accept: application/xml
Here is the structure of a request using the curl utility. The domain-id is the unique ID which is returned to you when you created the domain.
curl -i --url https://api.quantil.com/api/domain/ {domain-id}/history
-X GET
-u {user}: {password}
-H 'Date: Fri, 26 Oct 2012 06:33:26 GMT'
-H 'Accept: application/xml'
-H 'Content-Type: application/xml'
The following example using the curl command-line tool to obtain a domain's deployment history.
curl -i --url 'https://api.quantil.com/api/domain/5442/history' -X GET -u test:pXoktxJQnUEkaOurDbJ02Y0axzE= -H 'Date: Wed, 06 Aug 2014 14:12:25 PDT' -H 'Accept: application/xml'
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}
Element |
Description |
domainConfigHistory |
container for information from the QUANTIL server. It can contain zero or more <domainConfigRecord> elements which describe the history of deployments for the domain. |
domainConfigRecord |
this container describes a particular deployment. It includes these elements: <recordId>, <status>, <timestamp>, and <user>. |
recordId |
a value representing an entry in the domain's deployment history. You can use this value to retrieve the corresponding configuration. |
status |
Successful or Failed to indicate whether the deployment of a configuration was successful or not, In Progress to indicate it is not yet completed, or Waiting to indicate the deployment has not yet begun. |
timestamp |
An RFC 1123 format date indicating when the deployment request was made. |
user |
Indicates the name of the QUANTIL portal user who tried to deploy a change. It is empty if you call the API directly. |
comment |
A comment associated with the domain configuration. |
HTTP/1.1 200 OK
Date: Sat, 03 Jan 2015 00:59:41 GMT
Accept-Ranges: bytes
Server: WS-web-server
x-cnc-request-id: 4588489
ContentType: application/xml;charset=UTF-8
Content-Type: application/xml;charset=UTF-8
Content-Length: 938
<?xml version="1.0" encoding="UTF-8"?><domainConfigHistory>
<domainConfigRecord>
<recordId>4</recordId>
<status>Failed</status>
<timestamp>Wed, 31 Dec 2014 16:54:23 CST</timestamp>
<user>joeuser</user>
</domainConfigRecord>
<domainConfigRecord>
<recordId>3</recordId>
<status>Successful</status>
<comment>19.8.7.61</comment>
<timestamp>Tue, 30 Dec 2014 20:20:43 CST</timestamp>
<user>joeuser</user>
</domainConfigRecord>
<domainConfigRecord>
<recordId>2</recordId>
<status>Successful</status>
<comment>19.8.7.6</comment>
<timestamp>Tue, 30 Dec 2014 18:39:14 CST</timestamp>
<user>joeuser</user>
</domainConfigRecord>
<domainConfigRecord>
<recordId>1</recordId>
<status>Successful</status>
<comment>9.8.7.5</comment>
<timestamp>Tue, 30 Dec 2014 18:34:10 CST</timestamp>
<user>joeuser</user>
</domainConfigRecord>
</domainConfigHistory>
Error |
Description |
HTTP status code |
NoSuchDomain |
The specified domain does not exist. |
404 |