The DigiCert Services API is a powerful API that allows you to automate typical certificate processes to save time and streamline certificate management. The Services API uses modern RESTful conventions and is simple to use.
Use this base URL when constructing API requests:
https://www.digicert.com/services/v2Some endpoints use URL query strings to filter results. URL query strings are appended to the endpoint URL using ?, with additional query strings appended using &.
This example uses the container_id query string to filter results to the specified container. It also uses the limit query string to return only ten results.
https://www.digicert.com/services/v2/user?container_id=123&limit=10All API requests are submitted via RESTful URLs using REST features, including header-based authentication and JSON/XML request types.
The data character set encoding for requests is UTF-8. A well-formed request uses port 443 and has the user-agent and content-length headers specified.
DigiCert Services API uses these standard HTTP methods:
GETPOSTPUTDELETEMost requests require passing either JSON or XML formatted data. If an endpoint supports or requires a different format, it will be noted for that endpoint.
Supported content-type values include:
application/jsonapplication/xmlapplication/zipimage/jpegimage/pngSome GET requests support the option to filter and sort response data by using the filters[], sort, offset, and limit query parameters in the request URL.
To use filter or sorting parameters in a request, append them to the request URL with a ?. To apply multiple filters, append each filter parameter with an &.
For example:
https://www.digicert.com/services/v2/account/subaccount/invite?filters[status]=pending&sort=date_createdTo see which properties an endpoint supports for filtering, check the reference documentation for the endpoint. For general information and examples of the syntax to use when applying filters and sorting results, see the parameter descriptions in the table below.
| Name | Description |
|---|---|
filters[{{property_name}}]
|
Limits response to results where the chosen property_name contains a specific value. Replace {{property_name}} in your request with the property to use for filtering.If the value of the property is a date, you can filter by date range. To filter by date range, separate the start date and end date with an ellipsis ( ...). To return all results before or after a specific date, prefix the date with a less than (<) or greater than (>) symbol, respectively.Examples:
|
| filters[search] |
Limits response to results where the value of a searched property matches or contains a specific string of characters. To see a list of the searched properties for an endpoint, check the reference documentation for the endpoint. To search for values that contain a specific string of characters, prefix the string with a URL encoded (percent-encoded) % character: %25. To search for values that are an exact match for a string of characters, omit the %25 from the request.Examples:
|
| sort |
Sorts results by the value of one or more properties. By default, sorts results in ascending alphabetical order (0-9, A-Z). To sort in descending alphabetical order (9-0, Z-A), prefix the property name with a minus ( -).To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list. Examples:
|
| offset | Index of the first result to return. |
| limit | Total number of results to include in the response. |
Responses consist of headers and a body. The body is formatted based on the content-type specified in the request.
See Glossary – Headers for information about HTTP header response codes.
The Services API is in active development. Most enhancements are additive. API consumers should build integrations that can safely handle the addition of new response parameters and new optional request parameters.
Whenever possible, we notify API consumers before we change or remove the behaviors described in this documentation. Undocumented API endpoints, response fields, and request parameters are not officially supported and may change without notice.
If the documentation is unclear or missing information you need to build your integration, send us your feedback at docs@digicert.com.
curl -X POST \
'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}' \
-d '{
"text": "This is a note"
}'import requests
url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"
payload = "{\n\t\"text\": \"This is a note\"\n}"
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/xml"
}
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/{{order_id}}/note"
payload := strings.NewReader("{\n\t\"text\": \"This is a note\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
req.Header.Add("Content-Type", "application/xml")
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/{{order_id}}/note',
headers:
{ 'Content-Type': 'application/xml',
'X-DC-DEVKEY': '{{api_key}}' },
body: '{\n\t"text": "This is a note"\n}' };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});{
"id": 1,
"date_created": "2018-09-26T20:29:09+00:00",
"text": "This is a note",
"user": {
"id": 125039,
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@digicert.com"
}
}curl -X GET \
'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note' \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'import requests
url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/xml"
}
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}}/note"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
req.Header.Add("Content-Type", "application/xml")
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}}/note',
headers:
{ 'Content-Type': 'application/xml',
'X-DC-DEVKEY': '{{api_key}}' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});{
"notes": [
{
"id": 1,
"date_created": "2018-09-26T20:29:09+00:00",
"text": "This is a note",
"user": {
"id": 125039,
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@digicert.com"
}
}
]
}curl -X DELETE \
'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note/{{note_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}}/note/{{note_id}}"
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/xml"
}
response = requests.request("DELETE", 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}}/note/{{note_id}}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
req.Header.Add("Content-Type", "application/xml")
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: 'DELETE',
url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note/{{note_id}}',
headers:
{ 'Content-Type': 'application/xml',
'X-DC-DEVKEY': '{{api_key}}' } };
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});// empty