namecheap.ssl.getList

Returns a list of SSL certificates for a particular user.

Request Parameters

Global parameters are not shown here for clarity, but should be present in all requests

Name Type MaxLength Required? Default Description
ListType String 50 No ALL

Possible values are ALL,Processing,EmailSent,TechnicalProblem,InProgress,   Completed,Deactivated,Active,Cancelled,NewPurchase, NewRenewal.

SearchTerm String 70 No Keyword to look for on the SSL list
Page Number 10 No 1 Page to return
PageSize Number 100 No 20 Total number of SSL certificates to display in a page.   Minimum value is 10 and maximum value is 100.
SortBy String 20 No    Possible values are PURCHASEDATE, PURCHASEDATE_DESC, SSLTYPE, SSLTYPE_DESC, EXPIREDATETIME, EXPIREDATETIME_DESC,Host_Name, Host_Name_DESC.

Example Request

https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&
UserName=apiexample&Command=namecheap.ssl.getList&ClientIp=192.168.1.109

Example Response

<?xml version="1.0" encoding="utf-8" ?>
<ApiResponse Status="OK">
 <Errors/>
 <RequestedCommand>namecheap.ssl.getList</RequestedCommand>
 <CommandResponse Type="namecheap.ssl.getList">
  <SSLListResult>
     <SSL CertificateID="52546" HostName="domain12.com" SSLType="SSLCertificate1" 
          PurchaseDate="09/25/2006" ExpireDate="09/25/2007" ActivationExpireDate="12/31/2008" 
          IsExpiredYN="true" Status="inprogress"/>
     <SSL CertificateID="52547" HostName="domain12x.com"  SSLType="SSLCertificate2"
          PurchaseDate="09/26/2006" ExpireDate="09/26/2008"  ActivationExpireDate="12/31/2009" 
          IsExpiredYN="false" Status="inprogress"/>
     <SSL CertificateID="52556" HostName="domainxy.com"  SSLType="SSLCertificate3" 
          PurchaseDate="10/17/2006" ExpireDate="10/17/2008" ActivationExpireDate="12/31/2009" 
          IsExpiredYN="false" Status="new"/>
  </SSLListResult>
  <Paging>
    <TotalItems>3</TotalItems>
    <CurrentPage>1</CurrentPage>
    <PageSize>20</PageSize>
  </Paging>
 </CommandResponse>
<Server>SERVER</Server>
<GMTTimeDifference>+5:30</GMTTimeDifference>
<ExecutionTime>1.094</ExecutionTime>
</ApiResponse>

Error Codes

Specifies the error codes that might be returned from this method

Number Description
5050900 Unhandled exceptions
2011272 ListType is invalid

Comments

Comments

Support requests, bug reports, and off-topic comments will be deleted without warning.

Please do post corrections or additional information/ pointers for this article below. We aim to quickly move corrections into the documentation. Also, your comments may take some time to appear.

If you need specific help with your account, please contact Support

close
Left side occasional ads will now show here with an option to close and don't show again.

Need help? We're always here for you.

× Close