View SSL Certificate - GET /api/ssl/certificate/{certificate-id}
Get information about an SSL certificate that has been added to QUANTIL's system. 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.
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/{certificate-id}
-X GET
-u {user}: {password}
-H 'Date: Fri, 26 Oct 2012 06:33:26 GMT'
-H 'Accept: application/xml'
-H 'Content-Type: application/xml'
curl -i --url 'https://api.quantil.com/api/ssl/certificate/10303' -X GET -u test:sr2z/l6M/DF/gbzlvD34nnGwJt0= -H 'Date: Fri, 08 Aug 2014 16:35:44 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}
The Location header will have a URL you can use to get the status of the SSL certificate you added.
Element |
Description |
ssl-certificate |
container for SSL certificate information. It can include one of each of these elements: <name>, <comment>, <related-domains>, <type>, <is-owner>, <expiration-date>, <common-names>, <subject-alt-names>, <sig-algo>, <chain-certs>, <subject>, <serial-number>. |
name |
a descriptive name |
comment |
an optional comment describing the certificate |
related-domains |
a container object listing the domains using the SSL certificate. It contains zero or more <related-domain> objects which indicate the domains 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 |
certificate-hash |
an MD5 hash of the certificate file. It is used to avoid uploading duplicates. |
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. |
expiration-date |
It contains the expiration date extracted from the certificate. Example: 2016-02-25 00:10:08.0 UTC. Note that this element can appear as a child of the <ssl-certificate> object and as a child of the <chain-cert> object. |
common-names |
This is the value of the Common Names field in the certificate. |
subject-alt-names |
This container object can contain one or more <san> elements listing each of the Subject Alternative Name values in the certificate. These describe the hostnames supported by the certificate. |
san |
a value of Subject Alternative Name. Example: kb.example.com |
sig-algo |
indicates the signature algorithm used to sign the content and verify authenticity. Note that this element can appear as a child of the <ssl-certificate> object and as a child of the <chain-cert> object. |
chain-certs |
A container object indicating the chain certificates. It contains one or more <chain-cert> objects. |
chain-cert |
A container object which describes a chain certificate. It contains one <subject> element, a <sig-algo> element, and an <expiration-date> element. |
subject |
The subject of the certificate describes the owner of the certificate. Note that this element can appear as a child of the <ssl-certificate> object and as a child of the <chain-cert> object. |
serial-number |
The serial number is a value provided by the certificate authority. It is unique among all certificates from the certificate authority. |
HTTP/1.1 200 OK
Date: Sat, 28 Feb 2015 01:21:17 GMT
Accept-Ranges: bytes
Server: WS-web-server
x-cnc-request-id: 7214471
ContentType: application/xml;charset=UTF-8
Content-Type: application/xml;charset=UTF-8
Content-Length: 667
<?xml version="1.0" encoding="UTF-8"?><ssl-certificate>
<name>newssl</name>
<comment>this is my new certificate</comment>
<algorithm>des</algorithm>
<type>private</type>
<is-owner>true</is-owner>
<certificate-hash>66aab60f2d0f153e28c95bb044a5ef2d</certificate-hash>
<expiration-date>2016-02-25 00:10:08.0 UTC</expiration-date>
<common-names>example.server.com</common-names>
<related-domains>
<related-domain>
<domain-id>14232</domain-id>
<domain-name>wsatestdomain-b.com</domain-name>
</related-domain>
</related-domains>
<subject-alt-names/>
<share-ssl>false</share-ssl>
<sig-algo>SHA256WITHRSA</sig-algo>
<chain-certs><chain-cert><subject>CN=DigiCert SHA2 Secure Server CA,O=DigiCert Inc,C=US</subject>
<expiration-date>2023-03-08 12:00:00.0 UTC</expiration-date>
<sig-algo>SHA256WITHRSA</sig-algo></chain-cert></chain-certs>
<serial-number>713051007401eb7b5f928cba4628cbdd</serial-number>
<subject>CN=*.mileweb.com, O="Quantil, Inc.", L=Santa Clara, ST=CA, C=US</subject>
</ssl-certificate>
Error |
Description |
HTTP status code |
NoSuchCertificate |
The specified certificate does not exist.. |
404 |