This page describes products with the securesite_ssl_certificate
group name (see Glossary – Product identifiers).
Use this endpoint to submit an OV/EV certificate request order using ssl_ev_securesite
, ssl_ev_securesite_multi_domain
, ssl_securesite
, ssl_securesite_multi_domain
, or ssl_securesite_wildcard
as the ssl_certificate_id.
curl -X POST \
'https://www.digicert.com/services/v2/order/certificate/{{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",
"app.example.com"
],
"csr": "<csr>",
"server_platform": {
"id": 45
},
"signature_hash": "sha256",
"organization_units": [
"Accounting department"
]
},
"validity_years": 2,
"comments": "Message for the approver",
"disable_renewal_notifications": true,
"locale": "en",
"payment_method": "balance",
"skip_approval": true,
"organization": {
"id": 123456
},
"custom_fields": [
{
"metadata_id": 11,
"value": "Invoice #00001"
}
]
}'
import requests
url = "https://www.digicert.com/services/v2/order/certificate/{{ssl_certificate_id}}"
payload = "{\n \"certificate\": {\n \"common_name\": \"example.com\",\n \"dns_names\": [\n \"sub.example.com\",\n \"app.example.com\"\n ],\n \"csr\": \"<csr>\",\n \"server_platform\": {\n \"id\": 45\n },\n \"signature_hash\": \"sha256\",\n \"organization_units\": [\n \"Accounting department\"\n ]\n },\n \"validity_years\": 2,\n \"comments\": \"Message for the approver\",\n \"disable_renewal_notifications\": true,\n \"locale\": \"en\",\n \"payment_method\": \"balance\",\n \"skip_approval\": true,\n \"organization\": {\n \"id\": 123456\n },\n \"custom_fields\": [\n {\n \"metadata_id\": 11,\n \"value\": \"Invoice #00001\"\n }\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_certificate_id}}"
payload := strings.NewReader("{\n \"certificate\": {\n \"common_name\": \"example.com\",\n \"dns_names\": [\n \"sub.example.com\",\n \"app.example.com\"\n ],\n \"csr\": \"<csr>\",\n \"server_platform\": {\n \"id\": 45\n },\n \"signature_hash\": \"sha256\",\n \"organization_units\": [\n \"Accounting department\"\n ]\n },\n \"validity_years\": 2,\n \"comments\": \"Message for the approver\",\n \"disable_renewal_notifications\": true,\n \"locale\": \"en\",\n \"payment_method\": \"balance\",\n \"skip_approval\": true,\n \"organization\": {\n \"id\": 123456\n },\n \"custom_fields\": [\n {\n \"metadata_id\": 11,\n \"value\": \"Invoice #00001\"\n }\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/{{ssl_certificate_id}}',
headers:
{ 'Content-Type': 'application/json',
'X-DC-DEVKEY': '{{api_key}}' },
body:
{ certificate:
{ common_name: 'example.com',
dns_names: [ 'sub.example.com', 'app.example.com' ],
csr: '<csr>',
server_platform: { id: 45 },
signature_hash: 'sha256',
organization_units: [ 'Accounting department' ] },
validity_years: 2,
comments: 'Message for the approver',
disable_renewal_notifications: true,
locale: 'en',
payment_method: 'balance',
skip_approval: true,
organization: { id: 123456 },
custom_fields: [ { metadata_id: 11, value: 'Invoice #00001' } ] },
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"
}
],
"certificate_id": 113
}
{
"id": 112233,
"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>"
}
]
}
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). |
.. signature_hash | required | string |
Hash algorithm used to signing the certificate. Code signing certificates support only SHA-256. |
.. 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. |
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
|
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 (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.). |
locale | optional | string |
Language that the DCV email should use. See Glossary – Locale codes |
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 | 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 | Container for organization details. |
.. id | required | int |
ID of the organization to associate with the order. Alternatively, you can pass an organization object to add a new organization when submitting an order. See Create organization for object structure requirements. |
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. |
Name | Type | Description |
---|---|---|
id | int | Order ID. |
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 .
|