Order DV SSL

POST
https://www.digicert.com/services/v2/order/certificate/{{dv_ssl_certificate_id}}

This page describes products with the dv_ssl_certificate group name (see Glossary – Product identifiers).

Use this endpoint to submit a DV certificate request order using ssl_dv_geotrust, ssl_dv_rapidssl, wildcard_dv_geotrust, wildcard_dv_rapidssl, or cloud_dv_geotrust as the dv_ssl_certificate_id.

cURL
curl -X POST \
  'https://www.digicert.com/services/v2/order/certificate/{{dv_ssl_certificate_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "certificate": {
        "common_name": "example.com",
        "dns_names": [
        	"sub.example.com",
        	"log.example.com"
        ],
        "csr": "<csr>",
        "server_platform": {
            "id": 2
        }
    },
    "custom_expiration_date": "",
    "comments": "Message for the approver.",
    "container": {
        "id": 69748
    },
    "custom_renewal_message": "Renew me.",
    "skip_approval": true,
    "disable_ct": 0,
    "validity_years": 1,
    "custom_fields": [
        {
            "metadata_id": 12,
            "value": "Invoice #12345"
        }
    ],
    "payment_method": "balance",
    "dcv_method": "email",
    "dcv_emails": [
    	{
    		"dns_name": "example.com",
    		"email_domain": "example.com",
    		"email": "admin@example.com"
    	},
    	{
    		"dns_name": "sub.example.com",
    		"email_domain": "example.com",
    		"email": "jim.smith@example.com"
    	},
    	{
    		"dns_name": "log.example.com",
    		"email_domain": "example.com",
    		"email": "it@example.com"
    	}
    ],
    "locale": "en",
    "technical_contact": {
        "first_name": "Jim",
        "last_name": "Smith",
        "telephone": "555-555-5555",
        "job_title": "IT Admin",
        "email": "jim.smith@example.com"
    }
}'
Python
import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{dv_ssl_certificate_id}}"

payload = "{\n    \"certificate\": {\n        \"common_name\": \"example.com\",\n        \"dns_names\": [\n        \t\"sub.example.com\",\n        \t\"log.example.com\"\n        ],\n        \"csr\": \"<csr>\",\n        \"server_platform\": {\n            \"id\": 2\n        }\n    },\n    \"custom_expiration_date\": \"\",\n    \"comments\": \"Message for the approver.\",\n    \"container\": {\n        \"id\": 69748\n    },\n    \"custom_renewal_message\": \"Renew me.\",\n    \"skip_approval\": true,\n    \"disable_ct\": 0,\n    \"validity_years\": 1,\n    \"custom_fields\": [\n        {\n            \"metadata_id\": 12,\n            \"value\": \"Invoice #12345\"\n        }\n    ],\n    \"payment_method\": \"balance\",\n    \"dcv_method\": \"email\",\n    \"dcv_emails\": [\n    \t{\n    \t\t\"dns_name\": \"example.com\",\n    \t\t\"email_domain\": \"example.com\",\n    \t\t\"email\": \"admin@example.com\"\n    \t},\n    \t{\n    \t\t\"dns_name\": \"sub.example.com\",\n    \t\t\"email_domain\": \"example.com\",\n    \t\t\"email\": \"jim.smith@example.com\"\n    \t},\n    \t{\n    \t\t\"dns_name\": \"log.example.com\",\n    \t\t\"email_domain\": \"example.com\",\n    \t\t\"email\": \"it@example.com\"\n    \t}\n    ],\n    \"locale\": \"en\",\n    \"technical_contact\": {\n        \"first_name\": \"Jim\",\n        \"last_name\": \"Smith\",\n        \"telephone\": \"555-555-5555\",\n        \"job_title\": \"IT Admin\",\n        \"email\": \"jim.smith@example.com\"\n    }\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)
Go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{dv_ssl_certificate_id}}"

	payload := strings.NewReader("{\n    \"certificate\": {\n        \"common_name\": \"example.com\",\n        \"dns_names\": [\n        \t\"sub.example.com\",\n        \t\"log.example.com\"\n        ],\n        \"csr\": \"<csr>\",\n        \"server_platform\": {\n            \"id\": 2\n        }\n    },\n    \"custom_expiration_date\": \"\",\n    \"comments\": \"Message for the approver.\",\n    \"container\": {\n        \"id\": 69748\n    },\n    \"custom_renewal_message\": \"Renew me.\",\n    \"skip_approval\": true,\n    \"disable_ct\": 0,\n    \"validity_years\": 1,\n    \"custom_fields\": [\n        {\n            \"metadata_id\": 12,\n            \"value\": \"Invoice #12345\"\n        }\n    ],\n    \"payment_method\": \"balance\",\n    \"dcv_method\": \"email\",\n    \"dcv_emails\": [\n    \t{\n    \t\t\"dns_name\": \"example.com\",\n    \t\t\"email_domain\": \"example.com\",\n    \t\t\"email\": \"admin@example.com\"\n    \t},\n    \t{\n    \t\t\"dns_name\": \"sub.example.com\",\n    \t\t\"email_domain\": \"example.com\",\n    \t\t\"email\": \"jim.smith@example.com\"\n    \t},\n    \t{\n    \t\t\"dns_name\": \"log.example.com\",\n    \t\t\"email_domain\": \"example.com\",\n    \t\t\"email\": \"it@example.com\"\n    \t}\n    ],\n    \"locale\": \"en\",\n    \"technical_contact\": {\n        \"first_name\": \"Jim\",\n        \"last_name\": \"Smith\",\n        \"telephone\": \"555-555-5555\",\n        \"job_title\": \"IT Admin\",\n        \"email\": \"jim.smith@example.com\"\n    }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
NodeJS
var request = require("request");

var options = { method: 'POST',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{dv_ssl_certificate_id}}',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { certificate: 
      { common_name: 'example.com',
        dns_names: [ 'sub.example.com', 'log.example.com' ],
        csr: '<csr>',
        server_platform: { id: 2 } },
     custom_expiration_date: '',
     comments: 'Message for the approver.',
     container: { id: 69748 },
     custom_renewal_message: 'Renew me.',
     skip_approval: true,
     disable_ct: 0,
     validity_years: 1,
     custom_fields: [ { metadata_id: 12, value: 'Invoice #12345' } ],
     payment_method: 'balance',
     dcv_method: 'email',
     dcv_emails: 
      [ { dns_name: 'example.com',
          email_domain: 'example.com',
          email: 'admin@example.com' },
        { dns_name: 'sub.example.com',
          email_domain: 'example.com',
          email: 'jim.smith@example.com' },
        { dns_name: 'log.example.com',
          email_domain: 'example.com',
          email: 'it@example.com' } ],
     locale: 'en',
     technical_contact: 
      { first_name: 'Jim',
        last_name: 'Smith',
        telephone: '555-555-5555',
        job_title: 'IT Admin',
        email: 'jim.smith@example.com' } },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
201 Created (email)
{
  "id": 6484932,
  "certificate_id": 6079436
}
201 Created (dns-txt-token or http-token)
{
  "id": 6484932,
  "certificate_id": 6079436
  "dcv_random_value": "icru1984rnekfj"
}

Request parameters

For information about allowed values for certificate fields, see Publicly Trusted Certificates – Data Entries that Violate Industry Standards.

Name Req/Opt Type Description
certificate required object Certificate details.
.. common_name required string Domain to be secured.
.. dns_names optional array Additional domains to be secured.
Can result in additional costs. (See Best practices – Get both versions of a domain for free.)
.. csr required* string Certificate signing request (CSR).
.. organization_units optional array Department in your organization the certificate is for.
.. server_platform optional object Server platform type.
Default: -1 (other)
.. .. id required int Server platform ID.
See Glossary – Server platforms
renewed_thumbprint optional string If order is a renewal, enter the SHA-1 thumbprint of the previous order's primary certificate.
validity_years required int Number of years the certificate is valid.
Can be replaced by validity_days or custom_expiration_date.
Allowed values: 1, 2
validity_days optional int Number of days the certificate is valid after it is issued.
Overrides validity_years
custom_expiration_date optional string Custom expiration date for the certificate. Date must be less than 825 days in the future.
Overrides validity_days and validity_years
Format: yyyy-MM-dd
comments optional string Comments about the order for the approver.
auto_renew optional int Specify if the certificate should automatically renew.
Default: 0
Allowed values: 0 (enabled), 1 (disabled)
custom_renewal_message optional string Custom message to be included in renewal notifications.
disable_renewal_notifications optional bool Specify if renewal notification emails should be disabled.
Default: false
renewal_of_order_id optional int If order is a renewal, enter the previous order's ID.
payment_method optional string Specify the payment method to use.
Allowed values: balance, card, profile
Default: balance
dcv_method required string DCV method to use when verifying domain control.
See Glossary – DCV methods
dcv_emails optional array List specifying the email scope when sending DCV emails.
You can add an entry for each DNS name being secured by the certificate.
.. dns_name required string DNS name on the certificate that this scope should apply to.
.. email_domain required string WHOIS domain record to use to verify email addresses.
This value must match the dns_names base domain.
.. email optional string Email address to use when sending DCV emails.
This email address must appear on the WHOIS record for the domain specified in the email_domain parameter.
locale optional string Language that the DCV email should use.
See Glossary – Locale codes
skip_approval optional bool Specify if the order should skip the approval step and be immediately submitted for validation and issued when complete.
Default: false
disable_ct optional bool Specify if CT logging for the certificate should be disabled.
Order-specific CT logging must be enabled or this will be ignored. See Allow Users to Keep Certificates Out of CT Logs.
Default: false
container optional object If needed, specify the container the order should be placed under.
.. id required int Container ID.
custom_fields optional* array Account-specific custom fields.
*Whether or not these fields are required depends on your custom field settings.
.. metadata_id required int Custom field ID.
.. value required string Value for the custom field.
Data validation type depends on your custom field settings.
technical_contact optional object Technical contact details.
.. first_name required string
.. last_name required string
.. telephone required string
.. job_title optional string
.. email required string

Response parameters

Name Type Description
id int Order ID.
certificate_id int Certificate ID.
dcv_random_value string Random value used to validation domain control.
Only returned when using either dns-txt-token or http-token as the DCV method.