Get SSL Certificate List - GET /api/ssl/certificate
Get a list of all SSL certificates you have registered with QUANTIL.
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/ssl/certificate 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 -X GET -u {user}: {password} -H 'Date: Thu, 17 May 2012 19:37:58 GMT' -H 'Accept: application / xml'
curl -i --url 'https://api.quantil.com/api/ssl/certificate -X GET -u test:7FjxDx/j6xSILkHsO5SOCDkQfJ8= -H 'Date: Wed, 06 Aug 2014 11:04:18 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 |
ssl-certificates |
a container which contains zero or more <ssl-certificate> objects describing certificates registered in the system. |
ssl-certificate |
container for SSL certificate information. It will contain a <certificate-id> element. It can include one of each of these elements: <name>, <comment>, <type>, <certificate-hash>, <expiration-date>, <common-names>, <related-domains>, <share-ssl>, <is-owner>, <ssl-key-id>, and <serial-number>. If no domains use the certificate, there will not be a <related-domains> child. |
certificate-id |
an internal id for the certificate |
name |
a descriptive name |
comment |
an optional comment describing the certificate |
certificate-hash |
a value representing the hash of the SSL certificate file. It is used internally to help distinguish whether the same files are uploaded. |
expiration-date |
the expiration date of the SSL certificate |
common-names |
the domain names associated with the certificate. Note that common names are part of the certificate. |
share-ssl |
A value of true indicates if the certificate is shared one provided by QUANTIL; a value of false indicates it is not a shared certificate. |
is-owner |
true indicating if you uploaded the certificate. |
ssl-key-id |
If using a Certificate Signing Request (CSR) to generate a certificate, the value represents the private key's identifier. |
serial-number |
The serial number is a value provided by the certificate authority. It is unique among all certificates from the certificate authority. |
related-domains |
a container object listing the domains set up on QUANTIL to use the SSL certificate. It contains zero or more <related-domain> objects each describing a domain using the certificate. |
related-domain |
a container object describing a domain that uses the SSL certificate. It contains one <domain-id> element and one <domain-name> element |
domain-id |
id of the domain using the certificate |
domain-name |
name of the domain using the certificate |
HTTP/1.1 200 OK
Date: Fri, 08 Aug 2014 23:35:43 GMT
Accept-Ranges: bytes
Server: WS-web-server
x-cnc-request-id: 1148824
ContentType: application/xml;charset=UTF-8
Content-Type: application/xml;charset=UTF-8
Content-Length: 1334
<?xml version="1.0" encoding="UTF-8"?><ssl-certificates>
<ssl-certificate>
<certificate-id>10221</certificate-id>
<name>my big company cert</name>
<comment>cert1</comment>
<is-owner>true</is-owner>
<share-ssl>false<share-ssl>
</ssl-certificate>
<ssl-certificate>
<certificate-id>10303</certificate-id>
<name>new 22abc</name>
<comment>abcdefg</comment>
<related-domains>
<related-domain>
<domain-id>3423</domain-id>
<domain-name>mybigcompanywsa.com</domain-name>
</related-domain>
</related-domains>
<serial-number>3</serial-number>
<is-owner>true</is-owner>
<share-ssl>false<share-ssl>
</ssl-certificate>
<ssl-certificate>
<certificate-id>10376</certificate-id>
<name>ssl cert2</name>
<comment>hello</comment>
<related-domains>
<related-domain>
<domain-id>4147</domain-id>
<domain-name>mybigcompanywsa2.com</domain-name>
</related-domain>
</related-domains>
<serial-number>41</serial-number>
<is-owner>false</is-owner>
<share-ssl>true<share-ssl>
</ssl-certificate>
<ssl-certificate>
<certificate-id>10398</certificate-id>
<name>myname</name>
<comment>my comment</comment>
<serial-number>2</serial-number>
<is-owner>true</is-owner>
<share-ssl>false<share-ssl>
</ssl-certificate>
</ssl-certificates>
This API has no special error codes.