Ordina SSL (type_hint)

POST

https://www.digicert.com/services/v2/order/certificate/ssl

End of 2-year public SSL/TLS certificates

The Services API no longer issues public SSL/TLS certificates with a validity period greater than 397 days. Requests for public SSL/TLS certificates that specify an order validity greater than 1 year (or 397 days) create a new Multi-year Plan. To learn more about this change, see End of 2-year DV, OV, and EV public SSL/TLS certificates.

Use this endpoint to request or renew an SSL/TLS certificate using the product type_hint. To renew a certificate, you must place the request from the same account used to order the original certificate.

This endpoint automatically determines the appropriate SSL/TLS product for the request based on the submitted data. If a product cannot be determined, a 400 ambiguous_product error is returned.

Public SSL/TLS certificates support Multi-year Plans. With Multi-year Plans, you pick the SSL/TLS certificate, the certificate validity period, and the duration of coverage you want. To order a Multi-year Plan with this endpoint, use the order_validity object to set the validity period of the order (up to six years). Optionally, use the certificate.cert_validity parameter to customize the validity of the first certificate issued for the order. For more information, see Multi-year Plans.

Enterprise License Agreement (ELA) and Flat Fee contracts only support 1- and 2-year Multi-year Plans.

Example requests and responses

cURL

curl -X POST \
  https://www.digicert.com/services/v2/order/certificate/ssl \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
  "certificate": {
    "common_name": "example.com",
    "dns_names": [
      "example2.com",
      "example3.com"
    ],
    "csr": "<csr>",
    "signature_hash": "sha256",
    "server_platform": {
      "id": 2
    }
  },
  "order_validity": {
    "years": 1
  },
  "comments": "Example certificate for API documentation.",
  "container": {
    "id": 11
  },
  "product": {
    "type_hint": "ov"
  },
  "auto_renew": 1,
  "disable_renewal_notifications": false,
  "additional_emails": [
    "john.smith@digicert.com"
  ],
  "disable_ct": false,
  "skip_approval": true,
  "organization": {
    "id": 112233
  }
}'

Python

import requests

url = "https://www.digicert.com/services/v2/order/certificate/ssl"

payload = "{\n  \"certificate\": {\n    \"common_name\": \"example.com\",\n    \"dns_names\": [\n      \"example2.com\",\n      \"example3.com\"\n    ],\n    \"csr\": \"<csr>\",\n    \"signature_hash\": \"sha256\",\n    \"organization\": {\n      \"id\": 112233\n    },\n    \"server_platform\": {\n      \"id\": 2\n    }\n  },\n  \"order_validity\": {\n      \"years\": 1\n    },\n  \"comments\": \"Example certificate for API documentation.\",\n  \"container\": {\n    \"id\": 11\n  },\n  \"product\": {\n    \"type_hint\": \"ov\"\n  },\n  \"auto_renew\": 1,\n  \"disable_renewal_notifications\": false,\n  \"additional_emails\": [\n    \"john.smith@digicert.com\"\n  ],\n  \"disable_ct\": false,\n  \"skip_approval\": true,\n  \"organization\": {\n    \"id\": 112233\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/ssl"

	payload := strings.NewReader("{\n  \"certificate\": {\n    \"common_name\": \"example.com\",\n    \"dns_names\": [\n      \"example2.com\",\n      \"example3.com\"\n    ],\n    \"csr\": \"<csr>\",\n    \"signature_hash\": \"sha256\",\n    \"organization\": {\n      \"id\": 112233\n    },\n    \"server_platform\": {\n      \"id\": 2\n    }\n  },\n  \"order_validity\": {\n      \"years\": 1\n    },\n  \"comments\": \"Example certificate for API documentation.\",\n  \"container\": {\n    \"id\": 11\n  },\n  \"product\": {\n    \"type_hint\": \"ov\"\n  },\n  \"auto_renew\": 1,\n  \"disable_renewal_notifications\": false,\n  \"additional_emails\": [\n    \"john.smith@digicert.com\"\n  ],\n  \"disable_ct\": false,\n  \"skip_approval\": true,\n  \"organization\": {\n    \"id\": 112233\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/ssl',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { certificate: 
      { common_name: 'example.com',
        dns_names: [ 'example2.com', 'example3.com' ],
        csr: '<csr>',
        signature_hash: 'sha256',
        organization: { id: 112233 },
        server_platform: { id: 2 } },
     order_validity: { years: 1 },
     comments: 'Example certificate for API documentation.',
     container: { id: 11 },
     product: { type_hint: 'ov' },
     auto_renew: 1,
     disable_renewal_notifications: false,
     additional_emails: [ 'john.smith@digicert.com' ],
     disable_ct: false,
     skip_approval: true,
     organization: { id: 112233 } },
  json: true };

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

  console.log(body);
});

201 Created (one-step approval)

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

201 Created (two-step approval)

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

201 Created (auto approval)

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

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	Details about the certificate.
.. 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). See Glossary – CSR requirements 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 sign the certificate. Code signing certificates support only SHA-256.
.. ca_cert_id	optional^**	string	ID of the intermediate certificate authority (ICA) certificate to select as the issuing certificate. To get the `ca_cert_id` value for an ICA, use the Product list endpoint. Account administrators can customize the default and allowed ICAs for each product at the container or user role level. If you do not provide a value for this parameter in requests for a public SSL/TLS certificate, we issue the certificate using the default ICA. If you provide the `ca_cert_id` value for an ICA that is not allowed, the request returns an error^. To see the custom ICA settings for each product, use the Product limits endpoint. ^This parameter is ignored in requests for public SSL/TLS certificates if the option for ICA selection is not enabled for your account. Public DV flex certificates and non-flex TLS certificates don't support ICA selection. For more information, see ICA certificate chain option for public OV and EV flex certificates. ^** Required if `type_hint` is `private`.
.. organization_units	optional	array	Department in your organization the certificate is for. Deprecated. This field is ignored for public SSL/TLS certificate requests. See our knowledge base article.
.. server_platform	optional	object	Server platform type. Required for code signing certificate orders. Default: `-1` (other)
.. .. id	required	int	Server platform ID. See Glossary – Server platforms
.. cert_validity	optional	object	For public SSL/TLS certificate orders, defines the validity period of certificates issued for this order. Cannot exceed order validity period. If not provided, or if the cert_validity date is less than 365 days from the current date, the certificate's validity period defaults to the validity period of the order or the maximum certificate validity period defined by CA/B Forum baseline requirements, whichever is shorter. This object is not used for requests from accounts that do not have Multi-year Plans enabled.
.. .. years	optional	int	Number of years the certificate is valid after it is issued. Can be replaced with `cert_validity.days` or `cert_validity.custom_expiration_date`. Allowed value: `1`
.. .. days	optional	int	Number of days the certificate is valid after it is issued. Overrides `cert_validity.years`. Max: `397`
.. .. custom_expiration_date	optional	string	A custom expiration date for the certificate. Overrides `cert_validity.days` and `cert_validity.years`. Format: `dd MMM YYYY` (for example, `"09 JUN 2021"`) Range: Must be within 397 days of the date you request the certificate.
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 order. For public SSL/TLS certificates, order validity determines the length of a Multi-year Plan.
.. years	required^*	int	Number of years the order is valid. ^Can be replaced by `order_validity.days` or `order_validity.custom_expiration_date`. Range*: `1`-`6`
.. days	optional	int	Number of days the order is valid. Overrides `order_validity.years`. Max: `2190`
.. custom_expiration_date	optional	string	Custom expiration date for the order. Overrides `order_validity.days` and `order_validity.years`. Format: `dd MMM YYYY` (for example, `"09 JUN 2025"`) Range: Must be within six years of the date you request the order.
validity_years	optional	int	Number of years the order is valid. Deprecated. Use the `order_validity` object to set the validity period of the order. Use the `cert_validity` object to set the validity period of the certificate. Range: `1`-`6`
validity_days	optional	int	Number of days the order is valid. Deprecated. Use the `order_validity` object to set the validity period of the order. Use the `cert_validity` object to set the validity period of the certificate. Overrides `validity_years`. Max: `2190`
custom_expiration_date	optional	string	Custom expiration date for the order. Deprecated. Use the `order_validity` object to set the validity period of the order. Use the `cert_validity` object to set the validity period of the certificate. Overrides `validity_days` and `validity_years`. Format: `yyyy-MM-dd` Range: Must be within six years of the date you request the order.
comments	optional	string	Comments about the order for the approver.
apply_cr_discount	optional	bool	When `true`, applies any competitive replacement discounts that are available for the domains on the order. To calculate competitive replacement discounts before you place an order, use the List replacement benefits endpoint. Default: `false`
serial_number	optional	string	Serial number of the non-DigiCert certificate for which you expect to receive a competitive replacement discount when you place the order. If not provided, we use the information from your order request to look for a match among certificates on the CT log servers, and we apply a discount based on the best match we can find.
product	optional	object	Details about the product.
.. type_hint	optional	string	Specify the product type being passed. Allowed values: `ov`, `ev`, `grid`, `private`
auto_renew	optional	int	Specify if the order should automatically renew. Allowed values: `0` (disabled) or `1` (enabled) Default: `0`
auto_reissue	optional	int	Auto-reissue setting for the order. When auto-reissue is enabled for a Multi-year Plan, DigiCert automatically creates a reissue request for the most recently issued certificate when that certificate is within 30 days of expiring. Auto-reissue repeats until the order expires. To learn more about reissuing certificates in a Multi-year Plan, see Multi-year Plans. Allowed values: `0` (disabled) or `1` (enabled) Default: `0` (disabled) Note: We ignore the `auto_reissue` request parameter if: The product does not support Multi-year Plans. Multi-year Plans are disabled for the account.
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.
dcv_method	optional	string	DCV method to use when verifying domain control. See Glossary – DCV methods
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	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. If we find one matching organization, we automatically associate the order with that organization instead of creating a new one. If we find two or more matching organizations, we automatically associate the order with the oldest matching organization in your account instead of creating a new one. 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.
.. 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.
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 details about the domains in your account that are submitted for validation with the certificate order request. You must have an active validation for the domains in this array to prove you control the common name and each SAN on the order.
.. id	int	Domain ID of the domain in your account.
.. name	int	Name of the domain in your account.
.. dns_name	string	Common name or SAN on the order. To prove you control this domain, you must have an active validation for the domain associated with the `domains[].name` and `domains[].id` key/value pairs.
.. dcv_token	object	Object with details about the domain control validation (DCV) token for the domain. Not returned when using email as the DCV method. Note: The `dcv_token` object is not returned for domains that will be validated under the scope of another domain on the order, for domains that already exist in your account, or for subdomains of existing domains. For example, if you request a certificate to secure the newly created domains `example.com`, `www.example.com`, and `subdomain.example.com`, the response only includes a `dcv_token` object for `example.com`. To get the DCV token for an existing domain, use the Domain info endpoint.
.. .. token	string	Random value used to prove control over the domain.
.. .. status	string	Status of the domain validation process.
.. .. expiration_date	string	Timestamp of when the token will expire. Format: UTC timezone and ISO 8601 date
.. .. verification_value	string	Value for the DNS record target host field. Only returned if the DCV method is `dns-cname-token`.
.. .. http_token_url	string	Filename and location for the .txt file. Only returned if the DCV method is `http-token`.
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.

Example requests and responses

Request parameters

Response parameters

Informazioni