Order Private SSL

14 minute read

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

Note

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

Use this endpoint to request or renew a private SSL certificate. To renew a certificate, you must place the request from the same account used to order the original certificate.

Replace {{private_ssl_certificate_id}} in the URL with the product identifier for the type of certificate to order:

private_ssl_flex: Private SSL OV^*
private_ssl_plus: Private SSL Plus Certificate
private_ssl_wildcard: Private SSL Wildcard Certificate
private_ssl_multi_domain: Private SSL Multi Domain Certificate

Note

**^***The Private SSL OV certificate is a flexible certificate that supports any type of domain configuration. To activate this certificate type for your CertCentral account, contact your account manager or our

Support team](https://www.digicert.com/contact-us/). For more information, see [Flex certificates.

Note

You can only order certificates that are enabled for your account. Use the Product list endpoint to get the list of products available for your account.

Example requests and responses

curl -X POST \
  'https://www.digicert.com/services/v2/order/certificate/{{private_ssl_certificate_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "certificate": {
        "common_name": "192.168.1.195",
        "dns_names": [
        	"192.168.1.196",
        	"192.168.1.197"
        ],
        "csr": "<csr>",
        "server_platform": {
            "id": 45
        },
        "signature_hash": "sha256",
        "ca_cert_id": "10A101A05684"
    },
    "order_validity": {
        "years": 1
    },
    "disable_renewal_notifications": true,
    "locale": "en",
    "payment_method": "balance",
    "skip_approval": true,
    "organization": {
        "id": 123456
    }
}'

import requests

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

payload = "{\n    \"certificate\": {\n        \"common_name\": \"192.168.1.195\",\n        \"dns_names\": [\n        \t\"192.168.1.196\",\n        \t\"192.168.1.197\"\n        ],\n        \"csr\": \"<csr>\",\n        \"server_platform\": {\n            \"id\": 45\n        },\n        \"signature_hash\": \"sha256\",\n        \"ca_cert_id\": \"10A101A05684\"\n    },\n    \"order_validity\": {\n            \"years\": 1\n        },\n    \"disable_renewal_notifications\": true,\n    \"locale\": \"en\",\n    \"payment_method\": \"balance\",\n    \"skip_approval\": true,\n    \"organization\": {\n        \"id\": 123456\n    }\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text)

package main

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

func main() {

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

	payload := strings.NewReader("{\n    \"certificate\": {\n        \"common_name\": \"192.168.1.195\",\n        \"dns_names\": [\n        \t\"192.168.1.196\",\n        \t\"192.168.1.197\"\n        ],\n        \"csr\": \"<csr>\",\n        \"server_platform\": {\n            \"id\": 45\n        },\n        \"signature_hash\": \"sha256\",\n        \"ca_cert_id\": \"10A101A05684\"\n    },\n    \"order_validity\": {\n            \"years\": 1\n        },\n    \"disable_renewal_notifications\": true,\n    \"locale\": \"en\",\n    \"payment_method\": \"balance\",\n    \"skip_approval\": true,\n    \"organization\": {\n        \"id\": 123456\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))

}

var request = require("request");

var options = { method: 'POST',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{private_ssl_certificate_id}}',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { certificate: 
      { common_name: '192.168.1.195',
        dns_names: [ '192.168.1.196', '192.168.1.197' ],
        csr: '<csr>',
        server_platform: { id: 45 },
        signature_hash: 'sha256',
        ca_cert_id: '10A101A05684' },
     order_validity: { years: 1 },
     disable_renewal_notifications: true,
     locale: 'en',
     payment_method: 'balance',
     skip_approval: true,
     organization: { id: 123456 } },
  json: true };

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

  console.log(body);
});

{
  "id": 112233,
  "requests": [
    {
      "id": 113,
      "status": "pending"
    }
  ]
}

{
  "id": 112233,
  "requests": [
    {
      "id": 113,
      "status": "submitted"
    }
  ]
}

{
  "id": 112233,
  "requests": [
    {
      "id": 113,
      "status": "approved"
    }
  ],
  "domains": [
      {
          "id": 1469,
          "name": "example.com"
      },
      {
          "id": 1470,
          "name": "example2.com"
      },
      {
          "id": 1471,
          "name": "example3.com"
      }
  ],
  "certificate_id": 113
}

{
  "id": 112233,
  "domains": [
      {
          "id": 1469,
          "name": "example.com"
      },
      {
          "id": 1470,
          "name": "example2.com"
      },
      {
          "id": 1471,
          "name": "example3.com"
      }
  ],
  "certificate_id": 113
}

{
  "id": 112233,
  "certificate_id": 113,
  "certificate_chain": [
    {
      "subject_common_name": "example.com",
      "pem": "<pem_certificate>"
    },
    {
      "subject_common_name": "DigiCert SHA2 Secure Server CA",
      "pem": "<pem_certificate>"
    },
    {
      "subject_common_name": "DigiCert Global Root CA",
      "pem": "<pem_certificate>"
    }
  ]
}

Request parameters

Note

Use the Product list endpoint and locate the allowed_ca_certs array to identify possible ca_cert_id values.

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). Note: The Services API does not extract information from the CSR to fill in the details of a certificate request. You must provide values for all relevant request parameters, including certificate.common_name, certificate.dns_names, and organization.id. If you are requesting a certificate for an organization without an existing ID, you must provide values for all required parameters of the organization object.
.. signature_hash	required	string	Hash algorithm used to signing the certificate. Code signing certificates support only SHA-256.
.. ca_cert_id	optional^*	string	ID of the CA certificate that should sign the certificate. *Required if multiple CA certificates are configured.
.. 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.
.. profile_option	optional	string	If using custom certificate profiles, specify the profile name. Allowed values: See Glossary – Certificate profile options.
renewed_thumbprint	optional^*	string	If order is a renewal, enter the SHA-1 thumbprint of the previous order’s primary certificate. For more information, see How to check a certificate’s thumbprint. *Renewal orders must include either a renewed_thumbprint or renewal_of_order_id value.
order_validity	required	object	Defines the validity period of the certificate and order.
.. years	required^*	int	Number of years the certificate and order are valid. *Can be replaced by order_validity.days or order_validity.custom_expiration_date. Range: 1-3
.. days	optional	int	Number of days the certificate and order are valid. Overrides order_validity.years.
.. custom_expiration_date	optional	string	Custom expiration date for the certificate and order. Overrides order_validity.days and order_validity.years. Format: dd MMM YYYY (for example, “09 JUN 2025”)
validity_years	optional	int	Number of years the certificate and order are valid. Deprecated. Use the order_validity object to set the validity period of the certificate and order. Allowed values: 1 - 3
validity_days	optional	int	Number of days the certificate and order are valid. Deprecated. Use the order_validity object to set the validity period of the certificate and order. Overrides validity_years
custom_expiration_date	optional	string	Custom expiration date for the certificate and order. Deprecated. Use the order_validity object to set the validity period of the certificate and order. Overrides validity_days and validity_years Format:
yyyy-MM-dd
comments	optional	string	Comments about the order for the administrator or approver reviewing the order request. The comments value is stored on the order request. If the order skips the approval step (skip_approval is set to true), any provided comments value is ignored since CertCentral creates the order directly without creating a corresponding request.
auto_renew	optional	int	Specify if the certificate should automatically renew. Default:0 (disabled) Allowed values: 0 (disabled), 1 (enabled)
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
additional_emails	optional	array	Additional email addresses to receive certificate notification emails (e.g., certificate issuance, duplicate certificate, certificate renewals, etc.).
renewal_of_order_id	optional^*	int	If order is a renewal, enter the previous order’s ID. *Renewal orders must include either a renewed_thumbprint or renewal_of_order_id value.
payment_method	optional	string	Payment method for the order. Allowed values:
credit_card	conditional	object	Object with information about the credit card charged for the order. Required if `payment_method` is `card`.
.. number	required	string	Credit card number.
.. expiration_month	required	integer	Credit card expiration month. Format as a two-digit number between `01` (Jan) and `12` (Dec).
.. expiration_year	required	integer	Credit card expiration year. Format as a four-digit number. For example: `2026`
.. cvv	required	integer	Card verification value (CVV). Format as a three- or four-digit number. For example: `333` or `4444`
.. cardholder_name	required	string	Cardholder’s first and last name.
billing_address	conditional	object	Object with information about the billing address. Required if `payment_method` is `card`.
.. address	required	string	Billing street address.
.. address2	optional	string	Continuation of street address.
.. city	required	string	Billing city.
.. state	conditional	string	Billing state or province. Optional for some countries.
.. country	required	string	Billing country.
.. zip	conditional	string	Billing zip or postal code. Optional for some countries.
vat_number	optional	string	If the payment method is card (new credit card) or profile (default credit card), use the vat_number request parameter to set a value-added tax (VAT) or goods and services tax (GST) identification number for the order transaction. DigiCert includes this number on the transaction receipt as a reference for your financial records.
If omitted, DigiCert uses the VAT/GST number from the finance settings for the CertCentral account. If the VAT/GST number is absent from both the order request and account settings, DigiCert doesn’t store a VAT/GST number for the transaction.
Note
DigiCert only stores a VAT/GST number for credit card transactions. For orders using other payment methods, the vat_number request parameter is ignored.
VAT/GST numbers are not supported for DigiCert USA and DigiCert Japan billing entities. If the billing entity for the account is DigiCert, Inc. (US) or DigiCert Japan G.K. (Japan), the vat_number parameter is ignored, and DigiCert doesn’t store a VAT/GST number for the transaction. To learn more about your account’s billing entity, contact your account manager.
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
organization_contact	optional	object	Organization contact for the order. Include this object at the root of the request body to create the order with a different organization contact than the one assigned to the `organization` on the request. If omitted, the order uses the same organization contact assigned to the `organization`. Note: The order-level `organization_contact` is only used on the order. It does not replace the organization contact assigned to the `organization` on the request.
.. first_name	required	string	Contact first name.
.. last_name	required	string	Contact last name.
.. email	required	string	Contact email address.
.. job_title	optional	string	Contact job title.
.. telephone	optional	string	Contact telephone number.
.. telephone_extension	optional	string	Telephone extension.
technical_contact	optional	object	Technical contact for the order. Include this object at the root of the request body to create the order with a different technical contact than the one assigned to the `organization` on the request. If omitted, the order uses the same technical contact assigned to the `organization`. Note: The order-level `technical_contact` is only used on the order. It does not replace the technical contact assigned to the `organization` on the request.
.. first_name	required	string	Contact first name.
.. last_name	required	string	Contact last name.
.. email	required	string	Contact email address.
.. job_title	optional	string	Contact job title.
.. telephone	optional	string	Contact telephone number.
.. telephone_extension	optional	string	Telephone extension.
organization	required	object	Object with information about the organization to associate with the request. You can associate the request with an existing organization, or you can create a new organization when you submit the order request. To associate the request with an existing organization, pass the ID of the organization as the value of `organization.id` in the body of your request. To create a new organization, include the details of the organization in the `organization` object. For more information about the structure and required parameters of the `organization` object, see the Create organization documentation. Note: When you submit an order with organization details instead of providing an organization ID, we check the organizations that already exist in your account to avoid creating a duplicate. To override this behavior and force the request to create a new organization, set the `organization.skip_duplicate_org_check` parameter to `true` in the body of your request. Important: When you want to associate an order with an existing organization, we recommend always using the ID of the organization instead of the organization’s details in the body of your request. To get the ID values for organizations in your account, use the List organizations endpoint. Additionally, we recommend deactivating unused organizations to ensure they are never accidentally assigned to a new order request. To deactivate an organization, use the Deactivate organization endpoint.
.. id	required^*	int	The ID of an existing organization to associate with the order. To get the ID of organizations in your account, use the List organizations endpoint. *Not required if you are creating a new organization with your request.
.. contacts	conditional	array of objects	List of contacts for the organization.
When creating a new organization:
Providing an organization_contact is conditional. An organization_contact is required if the request is from a service user. If omitted, the organization is created and the authenticated user is used as the organization contact.
Providing a technical_contact is optional. If omitted, the organization is created with no technical contact.
When using an existing organization ID:
Providing an organization_contact and technical_contact is optional. If provided, the new organization and technical contact replace the existing contacts stored on the organization.
Note: By default, DigiCert creates the order with the organization contact and technical contact (if one exists) assigned to the organization on the request. To create the order with a different organization or technical contact than those assigned to the organization, include the organization_contact or technical_contact object at the root of the request payload.
.. skip_duplicate_org_check	optional	bool	Use `true` to skip the check for duplicate organizations in your account. When you skip this check, you force the request to create a new organization, regardless of whether the details you provide in the request match the details of an organization that already exists in your account. 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.
alternative_order_id	optional	string	A custom alphanumeric ID to assign the order. To see the `alternative_order_id` assigned to an order, use the Order info endpoint. Alternative order IDs do not replace the unique order ID that DigiCert assigns each order request. You cannot use alternative order IDs to search for or identify orders in API calls that require an `order_id` parameter in the URL path or request body. If the Require unique alternative order IDs option is enabled in your account settings, you cannot submit order requests with an alternative order ID that is already assigned to an order in your account. Use this feature to enable nonce order requests, or to prevent your integration from creating duplicate orders in cases where you do not receive a response from the API. Account administrators can toggle this option from the CertCentral console. From the Settings > Preferences page, open the Advanced Settings menu, and look for the Alternative order ID option. This parameter is always optional, even if the Require unique alternative order IDs option is enabled in your account. If a request does not use this parameter, no `alternative_order_id` value is assigned to the order. Maximum length: 64 characters Note: The Require unique alternative order IDs option may not appear in the advanced settings menu for all CertCentral accounts. To enable this option for your account, contact your account manager or our Support team.
enable_guest_access	optional	int	Whether to enable guest access for the order. This parameter is not allowed if guest access is disabled in your account settings. Allowed values: 1 (enabled) or 0 (disabled) Default: The default configuration for new orders is determined by your account settings. Account administrators can change these settings from the Guest Access page in the CertCentral console.

Response parameters

Name	Type	Description
id	int	Order ID.
organization	object	Container for new organization details. Only returned if a new organization was created with the order.
.. id	int	Organization ID for the new organization.
domains	array	List of objects with domain details. Returns details for new and existing domains on the order.
.. id	int	Domain ID for the domain.
.. name	int	Name of the domain.
requests	array	Contains information about the request.
.. id	int	Request ID.
.. status	string	Request status. Possible values: pending, submitted, approved, rejected
certificate_id	int	Certificate ID. Returned if request status is approved.
certificate_chain	array	Ordered list of objects with information about each certificate in the certificate chain (for example, SSL certificate, intermediate CA certificate, and root certificate). The first object in the array contains the end-entity certificate. The next objects contain the intermediate CA certificates. The final object contains the root certificate. Each certificate is signed by the certificate in the object that follows it. For example, the end-entity certificate is signed by the intermediate CA certificate. Note: This endpoint only returns the `certificate_chain` array for TLS certificates that DigiCert issues immediately. To get the certificate chain after DigiCert issues a certificate, use the Certificate chain endpoint.
.. subject_common_name	string	Common name on the certificate.
.. pem	string	PEM-encoded certificate data. Note: The `pem` response parameter includes newline characters `\r\n`, which are an inherent part of PEM-encoded certificates.