Status change list
3 minute read
https://www.digicert.com/services/v2/order/certificate/status-changes?minutes=10
Usage and limitations
This API operation requires you to specify a time frame using query string parameters. The total time frame cannot exceed seven days (10080 minutes, or 604800 seconds).
To list orders that changed status between now and up to seven days ago, use the minutes and seconds query parameters. Use these parameters alone, or combine them. For example:
curl -g --request GET 'https://www.digicert.com/services/v2/order/certificate/status-changes?minutes=10' \
--header 'X-DC-DEVKEY: {{api_key}}'curl -g --request GET 'https://www.digicert.com/services/v2/order/certificate/status-changes?seconds=60' \
--header 'X-DC-DEVKEY: {{api_key}}'curl -g --request GET 'https://www.digicert.com/services/v2/order/certificate/status-changes?minutes=1&seconds=30' \
--header 'X-DC-DEVKEY: {{api_key}}'To list orders that changed status more than seven days ago, use the status_last_updated date range filter (filters[status_last_updated]). For example:
Range: January 1, 2023 to January 7, 2023
curl -g --request GET 'https://www.digicert.com/services/v2/order/certificate/status-changes?filters[status_last_updated]=2023-01-01...2023-01-07' \
--header 'X-DC-DEVKEY: {{api_key}}'
Note
When using thestatus_last_updated filter, the response omits orders that changed status again after the end of the given time frame.Example requests and responses
curl -X GET \
'https://www.digicert.com/services/v2/order/certificate/status-changes?minutes=10' \
--header 'Content-Type: application/json' \
--header 'X-DC-DEVKEY: {{api_key}}'import requests
url = "https://www.digicert.com/services/v2/order/certificate/status-changes"
querystring = {"minutes":"10"}
payload = ""
headers = {
'X-DC-DEVKEY': "{{api_key}}",
'Content-Type': "application/json"
}
response = requests.request("GET", url, data=payload, headers=headers, params=querystring)
print(response.text)package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v2/order/certificate/status-changes?minutes=10"
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/status-changes',
qs: { minutes: '10' },
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);
});{
"orders": [
{
"order_id": 265,
"certificate_id": 112233,
"status": "issued"
},
{
"order_id": 264,
"certificate_id": 112232,
"status": "canceled"
},
{
"order_id": 263,
"certificate_id": 112231,
"status": "issued"
},
{
"order_id": 262,
"certificate_id": 112230,
"status": "rejected"
},
{
"order_id": 261,
"certificate_id": 112229,
"status": "issued"
},
{
"order_id": 260,
"certificate_id": 112228,
"status": "issued"
},
{
"order_id": 259,
"certificate_id": 112227,
"status": "issued"
}
]
}{}{
"errors": [
{
"code": "time_frame_too_long",
"message": "An error occurred while processing your request."
}
]
}Filters and URL query parameters
This endpoint supports filters, sorting, and pagination. For general information and examples of the syntax to use when applying filters and sorting results, see Services API - Filters, sorting, and pagination parameters.
Important
You must include at least one URL query string filter in your request.| Name | Req/Opt | Type | Description |
|---|---|---|---|
| minutes | optional | int | Limit results to orders that changed status in the last n minutes. Use alone, or combine with seconds. The total time frame (minutes plus seconds) cannot exceed seven days.Max: 10080 |
| seconds | optional | int | Limit results to orders that changed status in the last n seconds. Use alone, or combine with minutes. The total time frame (minutes plus seconds) cannot exceed seven days.Max: 604800 |
| filters[status_last_updated] | optional | string | Limits results to orders that changed status in the given date range. Date format is yyyy-MM-dd or yy-mm-dd+HH:mm:ss. Timezone is MDT. Use an ellipses (...) to separate start and end date.When using the status_last_updated filter, the response omits orders that changed status again after the end of the given time frame.Example: 2019-08-01+00:00:00...2019-08-07+23:59:59 |
Response parameters
| Name | Type | Description |
|---|---|---|
| orders | array | List of orders that changed status in the given time frame. When using the status_last_updated filter, the response omits orders that changed status again after the end of the given time frame. |
| .. order_id | int | Order ID. |
| .. certificate_id | int | Certificate ID. |
| .. status | string | Current order status. See Glossary – Order status. |