API Documentation

Everything you need to know, in one place

namecheap.ssl.create

Creates a new SSL certificate

Example Request

https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.ssl.create&ClientIp=192.168.1.109&Years=2&Type=RapidSSL

Request Parameters

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

Name Type MaxLength Required? Description
Years Number 1 Yes Number of years to register
Default Value: 1
PromotionCode String 20 No Promotional (coupon) code for the certificate
Type String 50 Yes Type of SSL
SANStoADD Number 2 No This parameter defines the number of add-on domains to be purchased in addition to the default number of domains included with a multi-domain certificate. Each certificate that supports SANs has the default number of domains included. You may check the default number of domains included and the maximum number of domains that can be added to it in the table below.
Default Value: 0
Provider Product name Default number of domains (domain from CSR is counted here) Maximum number of total domains Maximum number of domains that can be passed in SANStoADD parameter
Comodo PositiveSSL Multi-Domain 3 100 97
Comodo Multi-Domain SSL 3 100 97
Comodo EV Multi-Domain SSL 3 100 97
Comodo Unified Communications 3 100 97
GeoTrust QuickSSL Premium 1 1 domain + 4 subdomains The only supported value is 4
GeoTrust True BusinessID with EV Multi-Domain 5 25 20
GeoTrust True Business ID Multi-Domain 5 25 20
Thawte SSL Web Server 1 25 24
Thawte SSL Web Server with EV 1 25 24
Symantec Secure Site Pro with EV 1 25 24
Symantec Secure Site with EV 1 25 24
Symantec Secure Site 1 25 24
Symantec Secure Site Pro 1 25 24
Possible values for Type parameter:

QuickSSL Premium, RapidSSL, RapidSSL Wildcard, PremiumSSL, InstantSSL, PositiveSSL, PositiveSSL Wildcard, True BusinessID with EV, True BusinessID, True BusinessID Wildcard, True BusinessID Multi Domain, True BusinessID with EV Multi Domain, Secure Site , Secure Site Pro, Secure Site with EV, Secure Site Pro with EV, EssentialSSL, EssentialSSL Wildcard, InstantSSL Pro, PremiumSSL Wildcard, EV SSL, SSL123, SSL Web Server, SSL Webserver EV, EV Multi Domain SSL, Multi Domain SSL, PositiveSSL Multi Domain, Unified Communications.

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse Status="OK">
  <Errors />
  <RequestedCommand>namecheap.ssl.create</RequestedCommand>
  <CommandResponse Type="namecheap.ssl.create">
    <SSLCreateResult IsSuccess="true" OrderId="3186" TransactionId="4211" ChargedAmount="30.2000">
      <SSLCertificate CertificateID="500393" Created="06/26/2010" Expires="" SSLType="RapidSSL" Years="2" Status="NewPurchase" />
    </SSLCreateResult>
  </CommandResponse>
  <Server>IMWS-A03</Server>
  <GMTTimeDifference>+5:30</GMTTimeDifference>
  <ExecutionTime>0.219</ExecutionTime>
</ApiResponse>

Response Parameters

Name Description
IsSuccess Indicates whether SSL order was successful
Order ID A unique integer value that represents the order
TransactionID A unique integer value that represents the transaction
ChargedAmount The amount charged for the order
CertificateID A unique integer value that represents the SSL
Created The date on which the certificate is created
Expires The date on which the certificate expires
SSLType Type of SSL cerificate
Years Number of years for which the certificate is purchased
Status The current status of SSL certificate

Error Codes

Specifies the error codes that might be returned from this method

Number Description
2033409 Possibly a logical error in authentication phase. Order chargeable for Username is not found.
2015167 Number of years should be maximum 10
2011301 SSLType is invalid
2011170 Promotion code is invalid
4011299 The Purchasevalidationid already exists.The certificate cannot be created.
2528166 Order creation failed
5050900 Unhandled exceptions

Comments

We welcome your comments, questions, corrections and additional information relating to this article. Your comments may take some time to appear. Please be aware that off-topic comments will be deleted.

If you need specific help with your account, feel free to contact our Support Team. Thank you.

Need help? We're always here for you.

× Close