You can replace {{order_id}}
with a certificate's thumprint or serial number to get info for the specified certificate order.
Use this endpoint to get details for a certificate order.
Technical contact information is copied from the organization contact.
curl -X GET \
https://www.digicert.com/services/v2/order/certificate/{{order_id}}\
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'
import requests
url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}"
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/json"
}
response = requests.request("GET", url, headers=headers)
print(response.text)
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v2/order/certificate/{{order_id}}"
req, _ := http.NewRequest("GET", url, nil)
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: 'GET',
url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}',
headers:
{ 'Content-Type': 'application/json',
'X-DC-DEVKEY': '{{api_key}}' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
{
"id": 123456,
"certificate": {
"common_name": "example.com",
"dns_names": [
"example2.com",
"example3.com"
],
"date_created": "2018-10-16T20:05:28+00:00",
"csr": "<csr>",
"organization": {
"id": 112233
},
"organization_units": [
"Not Fake Company Inc."
],
"server_platform": {
"id": -1,
"name": "OTHER",
"install_url": "http://www.digicert.com/SSL-certificate-installation.htm",
"csr_url": "http://www.digicert.com/csr-creation.htm"
},
"signature_hash": "sha256",
"key_size": 2048,
"ca_cert": {
"id": "<cert_id>",
"name": "DigiCert SHA2 Secure Server CA"
}
},
"status": "needs_approval",
"is_renewal": false,
"date_created": "2018-10-16T20:05:28+00:00",
"organization": {
"id": 112233,
"name": "Epigyne Unwieldiness llc",
"assumed_name": "Epigyne Unwieldiness",
"display_name": "Epigyne Unwieldiness llc (Epigyne Unwieldiness)",
"city": "Minneapolis",
"state": "Minnesota",
"country": "us"
},
"validity_years": 1,
"disable_renewal_notifications": false,
"auto_renew": 0,
"auto_reissue": 0,
"container": {
"id": 15,
"name": "History Department",
"is_active": true
},
"product": {
"name_id": "ssl_plus",
"name": "Standard SSL",
"type": "ssl_certificate",
"validation_type": "ov",
"validation_name": "OV",
"validation_description": "Normal Organization Validation",
"csr_required": true
},
"organization_contact": {
"first_name": "Gia",
"last_name": "Booth",
"email": "gia.booth@inbox.com",
"job_title": "Clinical Laboratory Technician",
"telephone": "666-186-6450",
"telephone_extension": "736"
},
"technical_contact": {
"first_name": "Gia",
"last_name": "Booth",
"email": "gia.booth@inbox.com",
"job_title": "Clinical Laboratory Technician",
"telephone": "666-186-6450",
"telephone_extension": "736"
},
"user": {
"id": 44,
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@digicert.com"
},
"purchased_dns_names": 2,
"requests": [
{
"id": 198,
"date": "2018-10-16T20:05:28+00:00",
"type": "new_request",
"status": "pending",
"comments": "Certificate comment."
}
],
"public_id": "<public_id>",
"is_out_of_contract": false,
"payment_method": "balance",
"product_name_id": "ssl_plus",
"custom_fields": [
{
"metadata_id": 12,
"label": "Invoice #",
"value": "123456"
}
],
"disable_issuance_email": false,
"is_guest_access_enabled": false
}
{
"id": 123456,
"certificate": {
"common_name": "example.com",
"dns_names": [
"example2.com",
"example3.com"
],
"date_created": "2019-04-30T18:02:50+00:00",
"valid_from": "2019-04-30",
"valid_till": "2020-04-30",
"days_remaining": 289,
"csr": "<csr>",
"organization": {
"id": 112233
},
"organization_units": [
"Not Fake Company Inc."
],
"server_platform": {
"id": -1,
"name": "OTHER",
"install_url": "http://www.digicert.com/SSL-certificate-installation.htm",
"csr_url": "http://www.digicert.com/csr-creation.htm"
},
"signature_hash": "sha256",
"key_size": 2048,
"user_id": 12345
},
"status": "issued",
"is_renewal": false,
"date_created": "2019-04-30T18:02:50+00:00",
"organization": {
"id": 112233,
"name": "Epigyne Unwieldiness llc",
"assumed_name": "Epigyne Unwieldiness",
"display_name": "Epigyne Unwieldiness llc (Epigyne Unwieldiness)",
"city": "Minneapolis",
"state": "Minnesota",
"country": "us"
},
"validity_years": 1,
"disable_renewal_notifications": false,
"auto_renew": 0,
"auto_reissue": 0,
"container": {
"id": 15,
"name": "History Department",
"is_active": true
},
"product": {
"name_id": "ssl_plus",
"name": "Standard SSL",
"type": "ssl_certificate",
"validation_type": "ov",
"validation_name": "OV",
"validation_description": "Normal Organization Validation",
"csr_required": true
},
"organization_contact": {
"first_name": "Gia",
"last_name": "Booth",
"email": "gia.booth@inbox.com",
"job_title": "Clinical Laboratory Technician",
"telephone": "666-186-6450",
"telephone_extension": "736"
},
"technical_contact": {
"first_name": "Gia",
"last_name": "Booth",
"email": "gia.booth@inbox.com",
"job_title": "Clinical Laboratory Technician",
"telephone": "666-186-6450",
"telephone_extension": "736"
},
"user": {
"id": 44,
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@digicert.com"
},
"purchased_dns_names": 2,
"requests": [
{
"id": 198,
"date": "2018-10-16T20:05:28+00:00",
"type": "new_request",
"status": "pending",
"comments": "Certificate comment."
}
],
"public_id": "<public_id>",
"is_out_of_contract": false,
"payment_method": "balance",
"product_name_id": "ssl_plus",
"custom_fields": [
{
"metadata_id": 12,
"label": "Invoice #",
"value": "123456"
}
],
"disable_issuance_email": false
}
Name | Type | Description |
---|---|---|
id | int | Order ID. |
certificate | object | Details about the certificate. |
.. id | int | Certificate ID. |
.. thumbprint | string | Thumbprint of the certificate. |
.. serial_number * | string | Serial number of the certificate. |
.. common_name | string | Name secured by the certificate. |
.. cert_validity | object | Describes the validity period of the certificate. |
.. .. years | int |
Total number of years the certificate is valid. Only returned if you used years to set the validity period of the certificate. |
.. .. days | int |
Total number of days the certificate is valid. Only returned if you used days to set the validity period of the certificate. |
.. .. custom_expiration_date | int |
Expiration date for the certificate. Only returned if you used a custom expiration date to set the validity period of the certificate. |
.. emails | array | List of emails associated with the certificate. |
.. dns_names | array | List of additional names secured by the certificate. |
.. date_created | string |
Timestamp of when the certificate was created. Format: UTC timezone and ISO 8601 date |
.. valid_from * | string |
Date when certificate validity starts. Format: yyyy-MM-dd
|
.. valid_till * | string |
Expiration date of the certificate. Format: yyyy-MM-dd
|
.. days_remaining | int | Number of days until certificate expires. |
.. csr | string | Certificate signing request. |
.. organization | object | Organization on the certificate. |
.. .. id | int | Organization ID. |
.. organization_units | array | List of organization units on the certificate. |
.. server_platform | object | Details about the server platform. |
.. .. id | int |
Server platform ID. See Glossary – Server platforms |
.. .. name | string | Name of the server platform. |
.. .. install_url | string | URL for Certificate installation instructions. |
.. .. csr_url | string | URL for CSR generation instructions. |
.. signature_hash | string | Signing algorithm used by the certificate. |
.. key_size | int | Number of bits used in the key. |
.. ca_cert | object | Certificate authority (CA) certificate used to sign the certificate. |
.. .. id | string | CA certificate ID. |
.. .. name | string | Name of the CA. |
status | string |
Status of the order. See Glossary – Order status |
is_renewal | bool |
If true , the order is a renewal. Otherwise, false .
|
is_renewed | bool |
If true , the order has been renewed. Otherwise, false .
|
renewed_order_id | int |
Order ID of the previous order. Returned only if order is a renewal. |
was_renewed_by_order_id | int |
Order ID of the renewal for this order. Returned only if order has been renewed. |
date_created | string |
Order creation date. Format: UTC timezone and ISO 8601 date |
organization | object | Details about the organization associated with the order. |
.. id | int | Organization ID. |
.. name | string | Legal name of the organization. |
.. assumed_name | string |
Public name of the organization. Also called DBA name. |
.. display_name | string |
Full name of the organization. Constructed using name + assumed_name. |
.. city | string | City where the organization is located. |
.. state | string | State where the organization is located. |
.. country | string | Country where the organization is located. |
validity_years | string | Total number of years the order is valid. |
order_valid_from * | string |
Start date of the order validity period. Format: YYYY-MM-DD
|
order_valid_till * | string |
Expiration date of the order. Format: YYYY-MM-DD
|
order_validity | object | Describes the validity period of the order. For Multi-year Plans, order validity matches the duration of the plan. |
.. years | int |
Total number of years the order is valid. Only returned if you used years to set the validity period of the order. |
.. days | int |
Total number of days the order is valid. Only returned if you used days to set the validity period of the order. |
.. custom_expiration_date | string |
Expiration date of the order. Only returned if you used a custom expiration date to set the validity period of the order. |
disable_renewal_notifications | bool |
Whether renewal notifications are disabled for the order. If true , renewal notifications are disabled for the order. If false , renewal notifications are enabled.
|
auto_renew | int |
Auto-renew setting for the order. Possible values: 0 (disabled) or 1 (enabled)
|
auto_reissue | int |
Auto-reissue setting for the order. Possible values: 0 (disabled) or 1 (enabled)DigiCert Multi-year Plans support automatic reissue requests. When auto-reissue is enabled, 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. |
container | object | Details about the container associated with the order. |
.. id | int | Container ID. |
.. name | string | Name of the container. |
.. is_active | bool | Active status of the container. |
product | object | Details about the ordered product. |
.. name_id | string |
Name ID of the product. See Glossary – Product identifiers |
.. name | string |
Display name of the product. See Glossary – Product identifiers |
.. type | string |
Product type. See Glossary – Product types |
.. validation_type | string |
Validation type used by the product. See Glossary – Validation types |
.. validation_name | string | Display name of the validation type. |
.. validation_description | string | Description of the validation type. |
.. csr_required | bool | Specifies if a CSR is required for the product type. |
organization_contact | object |
Details about the organization contact on the order. See Structures – Contact details object. |
technical_contact | object |
Details about the technical contact on the order. See Structures – Contact details object. |
user | object |
Details about the user that submitted the order. See Structures – User details object. |
purchased_dns_names | int | Number of additional SANs purchased. |
requests | array | List of objects with details about requests associated with the order. |
.. id | int | Request ID. |
.. date | string |
Timestamp of when the request was submitted. Format: UTC timezone and ISO 8601 date |
.. type | string |
Request type. Possible values: new_request , revoke , duplicate , reissue
|
.. status | string |
Status of the request. Possible values: submitted , pending , approved , rejected
|
.. comments | string |
Message about the request. Not included if there are no comments associated with the request. |
receipt_id | int | Receipt ID. |
cs_provisioning_method | string |
For document and EV code signing orders, specifies the method by which the token will be sent. See Glossary – CS provisioning methods |
public_id | string | ID used for express installations. |
allow_duplicates | bool | Specifies if the order allows duplicate certificates. |
user_assignments |
List of users that created or have been assigned to the order. See Structures – User details object. |
|
is_out_of_contract | bool | Contract status of the order. |
payment_method | string |
Payment method used for the order. Possible values: balance (account balance), credit (credit card), profile (account default payment)
|
product_name_id | string |
Name ID of the product. See Glossary – Product identifiers |
custom_fields | array | List of custom field data. |
.. metadata_id | int | Custom field metadata ID. |
.. label | string | Name of the custom field. |
.. value | string | Entered value for the custom field. |
disable_issuance_email | bool | Specifies if issuance emails are sent. |
disable_ct | bool | Specifies if the certificate will be logged in public CT logs. |
alternative_order_id | string |
The custom alphanumeric ID assigned to the order. 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.Only returned if the original order request included a value for the alternative_order_id request parameter.
|
api_key | object |
Specifies if the order was requested via Services API or ACME. Omitted if order was requested via another method (e.g., CertCentral account, Guest Request URL, etc.). |
.. name | string | Name of the API key or ACME Directory URL. |
.. key_type | string |
Key type used for the request. Possible values: api_key (API), acme_url (ACME)
|
benefits | object | Object with information about competitive replacement discounts and other benefits applied to the order. |
.. actual_price | string | Price before benefits and other discounts. |
.. discount_percent | string | Total discount percentage applied. |
.. benefits | array |
Lists the different types of benefit applied to the order. Possible values: cr_benefit
|
.. benefits_data | object | Object with information about each benefit applied to the order. |
.. .. cr_benefit | object | Object with information about the competitive replacement benefit applied to the order. |
.. .. .. type | string |
Type of competitive replacement benefit applied to the order. Possible values: DISCOUNT
|
.. .. .. discount_percentage | float |
Total percentage discount applied to the actual_price of the order. Discount percentage is the sum of the competitive replacement discount and the premium discount percentage.
|
.. .. .. premium_discount_percentage | float | Percentage discount applied for ordering a premium DigiCert product. |
.. .. .. availed_domains | array | List of domains on the order that were eligible for competitive replacement benefits. |
is_multi_year_plan | string |
Returns "1" if the order is a Multi-year Plan.This parameter is not returned if the order is not a Multi-year Plan |
is_guest_access_enabled | bool |
If true , guest access is enabled for the order. Otherwise, false .
|
* - Returned only for issued certificate orders.