Get Domain List - GET /api/domain

Parent Previous Next

GET /api/domain                              

Get a list of domains configured to use QUANTIL's service.  A summary of each domain's status is included.


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/domain 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/domain -X GET -u {user}: {password} -H 'Date: Thu, 17 May 2012 19:37:58 GMT' -H 'Accept: application / xml'


Sample Request:


curl -i --url 'https://api.quantil.com/api/domain' -X GET -u test:bpUz2GQLqnw+6tTqKes6KYNpdLk= -H 'Date: Wed, 06 Aug 2014 17:17:47 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

domain-list

a container object which can include 0 or more <domain-summary> elements each describing a domain.

domain-summary

an element which describes a domain registered in QUANTIL. It contains the following child elements: <domain-id>, <domain-name>, <service-type>, <cname>, <status>, <cdn-service-status>, and <enabled>.

domain-id

id of the domain. This unique id should be passed when modifying a domain or getting the domain's configuration.

service-type

type of service that the domain is using (web, wsa, download, vodstream, live-push, live-pull, or live-hls).  Please refer to this mapping of the service names to QUANTIL's products.

cname

This is generated by the QUANTIL service. You need to change the CNAME for your domain to this value. This does not apply to live-push, live-pull,  and live-hls domains.

status

Its values can be InProgress or Deployed.  InProgress means we have received your configuration request, but it has not been deployed to all cache servers around the world.  Deployed means the configuration is fully deployed, so all users should see the benefits of QUANTIL's acceleration.

cdn-service-status

true or false to indicate whether QUANTIL's servers will be used to serve content. If false, the users' requests for content will be directed to your origin server.

enabled

If false, a user request to the domain will result in an error response such as HTTP status code 500. If true, the request will be handled normally.

ssl-status

This element indicates if the domain is using SSL. '0' means it is not using SSL;  '1' means it uses SSL;  '2' means it uses SNI.

Sample Response:


HTTP/1.1 200 OK

Date: Thu, 07 Aug 2014 00:17:45 GMT

Accept-Ranges: bytes

Server: WS-web-server

x-cnc-request-id: 1117422

ContentType: application/xml;charset=UTF-8

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

Content-Length: 2968


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

   <domain-summary>

   <domain-id>5440</domain-id>

   <domain-name>mynewtestdomain.com</domain-name>

   <service-type>web</service-type>

   <cname>kupxli6bqru7hi.wscloudcdn.com</cname>

   <status>Deployed</status>

   <cdn-service-status>true</cdn-service-status>

   <enabled>true</enabled>

   <ssl-status>0</ssl-status>

 </domain-summary>

 <domain-summary>

   <domain-id>5442</domain-id>

   <domain-name>mynewtestdomain1.com</domain-name>

   <service-type>web</service-type>

   <cname>kmi6qlgd000or3.wscloudcdn.com</cname>

   <status>Deployed</status>

   <cdn-service-status>true</cdn-service-status>

   <enabled>true</enabled>

  <ssl-status>2</ssl-status>

 </domain-summary>

</domain-list>

Error List

This API has no special error codes.