Check SSL Certificate's Allowed Domains - GET /api/ssl/certificate/{certificate-id}/checkdomains/{domainNames}

Parent Previous Next

GET /api/ssl/certificate/{certificate-id}/checkdomains/{domainNames}                        

Determine if a certificate uploaded to QUANTIL contains the domain as a Common Name or Subject Alternative Name. Using a certificate with a domain that is unsupported will cause browser warnings to appear when users visit the domain.  Certificate-id is a unique id returned in the Location header of the HTTP Response when you added the certificate. It is also returned by the Get Certificate List API. Domain-names is a comma separated list of domains to check.


Note: if a certificate has values for both Subject Alternative Names and Common Name, only the Subject Alternative Names will be checked.

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


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

Request Syntax:


GET /api/ssl/certificate/{certificate-id}/checkdomains/{domain-name} 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/ssl/certificate/{certificate-id}/checkdomains/{domain-name}

-X GET

-u {user}: {password}

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

-H 'Accept: application / xml'

-H 'Content-Type: application / xml'


Sample Request:

curl -i --url 'https://api.quantil.com/api/ssl/certificate/10303/checkdomains/domain.com' -X GET -u test:sr2z/l6M/DF/gbzlvD34nnGwJt0= -H 'Date: Fri, 08 Aug 2014 16:35:44 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

ssl-certificate-supported-domains

container which indicates whether a certificate supports a domain. It will contain a <domains> element.

domains

a container object which has one or more <domain> elements describing whether the domain is supported by the certificate.

ssl-certificate-id

indicates the ID of the SSL certificate being checked

domain

a container object describing whether a domain is supported. It contains an <is-supported> element and a <domain-name> element.

is-supported

its value is true if the domain is supported by the certificate, false otherwise.

domain-name

name of the domain being checked




Sample Response:


HTTP/1.1 202 Accepted

Date: Thu, 26 Feb 2015 02:23:24 GMT

Accept-Ranges: bytes

Server: WS-web-server

x-cnc-request-id: 7092784

ContentType: application/xml;charset=UTF-8

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

Content-Length: 296


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

<ssl-certificate-supported-domains>

 <domains>

   <domain>

     <is-supported>false</is-supported>

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

   </domain>

 </domains>

 <ssl-certificate-id>12856</ssl-certificate-id>

</ssl-certificate-supported-domains>


Error List


Error

Description

HTTP status code

InvalidCertificate

The certificate you provided is invalid.

403