Order Private SSL
POST https://www.digicert.com/services/v2/order/certificate/{{private_ssl_certificate_id}}
Notice
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 Certificateprivate_ssl_wildcard
: Private SSL Wildcard Certificateprivate_ssl_multi_domain
: Private SSL Multi Domain Certificate
Notice
*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. 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
Request parameters
Notice
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 |
.. 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: |
.. .. 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 |
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 Range: |
.. days | optional | int | Number of days the certificate and order are valid. Overrides |
.. custom_expiration_date | optional | string | Custom expiration date for the certificate and order. Overrides Format: |
validity_years | optional | int | Number of years the certificate and order are valid. Deprecated. Use the Allowed values: |
validity_days | optional | int | Number of days the certificate and order are valid. Deprecated. Use the |
custom_expiration_date | optional | string | Custom expiration date for the certificate and order. Deprecated. Use the Format: |
comments | optional | string | |
auto_renew | optional | int | Specify if the certificate should automatically renew. Default: Allowed values: |
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: |
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 |
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 |
.. number | required | string | Credit card number. |
.. expiration_month | required | integer | Credit card expiration month. Format as a two-digit number between |
.. expiration_year | required | integer | Credit card expiration year. Format as a four-digit number. For example: |
.. cvv | required | integer | Card verification value (CVV). Format as a three- or four-digit number. For example: |
.. cardholder_name | required | string | Cardholder’s first and last name. |
billing_address | conditional | object | Object with information about the billing address. Required if |
.. 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 | |
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. |
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 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. |
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: |
certificate_id | int | Certificate ID. Returned if request status is |
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 |
.. subject_common_name | string | Common name on the certificate. |
.. pem | string | PEM-encoded certificate data. |