ssl_list

List the SSL certificates of the account.

Inputs Description Type Regular expression Mandatory
start Number of the first certificate to list (pagination) int No
number Number of certificates to list (pagination) (0 = all) int No
valid List the currently validated certificates boolean No
expired List the currently expired certificates boolean No
to_renew List the currently renewable certificates boolean No
pending List the certificates currently being created boolean No

 

Outputs Description Possible values
SSL_Certificate Certificate with the following data
handle Certificate handle
status Certificate Status REGISTERED
DELETED
CANCELED
PENDING
product Product of certificate certificat Alpha SSL
certificate Domain SSL
certificate Wildcard SSL
certificate Organization SSL
certificate Business SSL
adminContact Certificate Administrative Contact
billingContact Certificate billing contact
regDate Date of registration of certificate
expDate Certificate expiration date

 

Error code

Error code Parameter Message Value comment
501 paramètre entrant (input) Command syntax error The ‘paramètre entrant (input)’ element has an invalid value according to its data type The ‘paramètre entrant (input)’ tag is empty or its contents can not be validated by the regular expression
730 No response No response No response

 

Command

<api>
[…]
<command>
<ssl_list>
<start>…</start>
<number>…</number>
<valid>…</valid>
<expired>…</expired>
<to_renew>…</to_renew>
<pending>…</pending>
</ssl_list>
</command>
</api>

Response

<?xml version="1.0" encoding="utf-8"?>
<api>
<response>
<trID>…</trID>
<result code="…">
<msg>…</msg>
</result>
</response>
<resData>
<ssl_listData>
<SSLCertificate>
<handle>…</handle>
<status>…</status>
<product>…</product>
<adminContact>…</adminContact>
<billingContact>…</billingContact>
<regDate>…</regDate>
<expDate>…</expDate>
</SSLCertificate>
</ssl_listData>
</resData>
</api>