API Documentation

Everything you need to know, in one place

Important: Only HTTP POST is supported for this method.

namecheap.ssl.parseCSR

Parses the CSR

Request Parameters

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

Name Type MaxLength Required? Description
csr String 2000 Yes Certificate Signing Request
CertificateType String 50 No* Type of SSL Certificate
Note: *This parameter is not mandatory, but we recommend specifying it for each call.
Possible values for CertificateType parameter:

InstantSSL, PositiveSSL, PositiveSSL Wildcard, EssentialSSL, EssentialSSL Wildcard, InstantSSL Pro, PremiumSSL Wildcard, EV SSL, EV Multi Domain SSL, Multi Domain SSL, PositiveSSL Multi Domain, Unified Communications.

Receiving file credentials for HTTP-based validation

In order to receive name and contents of file to be submitted on server, please use the following parameter:

Name Type MaxLength Required? Description
HTTPDCValidation String 10 No In case this parameter is set to True for Comodo certificates, you will receive filename and file content in API response.

Example Response (in this example, HTTPDCValidation is set to True for Comodo certificate)

<ApiResponse Status="OK">
  <Errors />
  <Warnings />
  <RequestedCommand>namecheap.ssl.parseCSR</RequestedCommand>
  <CommandResponse Type="namecheap.ssl.parseCSR">
    <SSLParseCSRResult>
      <CSRDetails>
        <CommonName>domain.com</CommonName>
        <DomainName>domain.com</DomainName>
        <Country>US</Country>
        <OrganisationUnit>com</OrganisationUnit>
        <Organisation>Org</Organisation>
        <ValidTrueDomain>false</ValidTrueDomain>
        <State>California</State>
        <Locality>la</Locality>
        <Email>someemail@domain.com</Email>
      </CSRDetails>
      <HttpDCValidation ValueAvailable="true">
        <FileName><![CDATA[776DE8TT1FA13356DAB9JJ0F1ACDXSD2.txt]]></FileName>
        <FileContent><![CDATA[UUU2310A0C5S55223FC560CT432259CB4177C79D
comodoca.com]]></FileContent>
      </HttpDCValidation>
    </SSLParseCSRResult>
  </CommandResponse>
  <Server>WEB1-SANDBOX1</Server>
  <GMTTimeDifference>--5:00</GMTTimeDifference>
  <ExecutionTime>0.711</ExecutionTime>
</ApiResponse>

Response Parameters

Name Description
Common name The hostname for which SSL is applied.
Domain name The domain name for which SSL is applied.
Country Country of the SSL applicant.
Organisation Unit Organisation unit of the SSL applicant.
Organisation Organisation of the SSL applicant.
ValidTrueDomain This value is returned by GeoTrust provider only. It indicates whether CSR parse was successful.
State State information of the SSL applicant.
Locality Locality information of the SSL applicant.
Email Email address of the SSL applicant.
HTTPDCValidation ValueAvailable Indicates whether HTTPDCValidation is available. Possible values: True, False.

Error Codes

Specifies the error codes that might be returned from this method

Number Description
2011300 CertificateType is invalid
3022296 Failed to retrive CSR details from provider
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