Order SSL (type_hint)
POST https://www.digicert.com/services/v2/order/certificate/ssl
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 three 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.
Warning
End of 4- to 6-year Multi-year Plans
On October 31, 2023, DigiCert will no longer sell 4- to 6-year Multi-year Plans for TLS and VMC certificates. We will continue to offer 1, 2, and 3-year Multi-year Plans. For more information, see End of 4- to 6-year Multi-year Plans.
Notice
Enterprise License Agreement (ELA) and Flat Fee contracts only support 1- and 2-year Multi-year Plans.
Example requests and responses
Request parameters
Notice
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 |
.. 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 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 TLS/SSL certificate, we issue the certificate using the default ICA. If you provide the *This parameter is ignored in requests for public TLS/SSL certificates if the option for ICA selection is not enabled for your account. Learn more about the ICA certificate chain feature for your public TLS certificates. ** Required if |
.. organization_units | optional | array | Department in your organization the certificate is for. Deprecated. This field is ignored for public TLS/SSL certificate requests. See our knowledge base article. |
.. server_platform | optional | object | Server platform type. Required for code signing certificate orders. Default: |
.. .. id | required | int | Server platform ID. See Glossary – Server platforms |
.. cert_validity | optional | object | 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 Allowed value: |
.. .. days | optional | int | Number of days the certificate is valid after it is issued. Overrides Max: |
.. .. custom_expiration_date | optional | string | A custom expiration date for the certificate. Overrides Format: 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 |
order_validity | required | object | Defines the validity period of the order. For public TLS/SSL 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 Range: |
.. days | optional | int | Number of days the order is valid. Overrides Max: |
.. custom_expiration_date | optional | string | Custom expiration date for the order. Overrides Format: Range: Must be within three years of the date you request the order. |
validity_years | optional | int | Number of years the order is valid. Deprecated. Use the Range: |
validity_days | optional | int | Number of days the order is valid. Overrides Deprecated. Use the Max: |
custom_expiration_date | optional | string | Custom expiration date for the order. Overrides Deprecated. Use the Format: Range: Must be within three years of the date you request the order. |
comments | optional | string | |
apply_cr_discount | optional | bool | When Default: |
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: |
auto_renew | optional | int | Specify if the order should automatically renew. Allowed values: Default: |
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: Default: Note: We ignore the
|
disable_renewal_notifications | optional | bool | Specify if renewal notification emails should be disabled. Default: |
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 |
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: |
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: |
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 Note: The order-level |
.. first_name | required | string | Contact first name. |
.. last_name | required | string | Contact last name. |
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 Note: The order-level |
.. first_name | required | string | Contact first name. |
.. last_name | required | string | Contact last name. |
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 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 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 | |
.. skip_duplicate_org_check | optional | bool | Use Default: |
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 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 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 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: 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. |
certificate_dcv_scope | optional | string |