Use this endpoint to get details about the vulnerability scan for an order.
Replace {{order_id}}
in the URL with the ID of the order. To get the ID values for orders in your account, use the List orders endpoint.
curl -X GET \
https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/details \
-H 'Content-Type: application/json' \
-H 'X-DC-DEVKEY: {{api_key}}'
import requests
url = "https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/details"
payload = {}
headers = {
'Content-Type': 'application/json',
'X-DC-DEVKEY': '{{api_key}}'
}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/details"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
res, err := client.Do(req)
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
}
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/details',
'headers': {
'Content-Type': 'application/json',
'X-DC-DEVKEY': '{{api_key}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
{
"domains_scan_details": [
{
"host_name": "wssqa.net",
"scan_start_date": "2020-06-08 00:19:34.0",
"scan_end_date": "2020-06-09 00:00:00.0",
"vulnerability_status": "SECURE",
"notification_status": "ALWAYS_NOTIFY",
"critical_vulnerabilities_count": 0,
"severe_vulnerabilities_count": 0,
"moderate_vulnerabilities_count": 0,
"is_download_available": true,
"is_rescan_available": false,
"is_site_enabled": true
}
],
"page": {
"total": 1,
"limit": 1000,
"offset": 0
}
}
{
"errors": [
{
"code": "not_found|route",
"message": "The specified route was not found."
}
]
}
{
"errors": [
{
"code": "access_denied",
"message": "You do not have permission to manage this request."
}
]
}
{
"errors": [
{
"code": "va_bad_request",
"message": "API request invalid. Validate allowed parameters and try again."
}
]
}
{
"errors": [
{
"code": "va_not_eligible_order",
"message": "Invalid order status. Order must be issued, not revoked, expired, or pending."
}
]
}
{
"errors": [
{
"code": "va_not_eligible_product",
"message": "Invalid certificate type. Vulnerability assessment is only available for Secure Site EV and Secure Site Pro certificates."
}
]
}
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.
Name | Req/Opt | Type | Description |
---|---|---|---|
filters[{{property_name}} ]
|
optional | string |
Filters results by the specified property. Replace {{property_name}} in your request with the property to use for filtering. This endpoint supports filtering by the following properties:
|
sort | optional | string |
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. This endpoint supports sorting by the following properties:
|
offset | required | int |
Index of the first result to include in the response. Default: 0
|
limit | required | int |
Total number of results to include in the response. Max: 1000
|
Name | Type | Description |
---|---|---|
domains_scan_details | array | List of objects with vulnerability assessment details for domains on the scanned order. |
.. host_name | string | The scanned domain. |
.. scan_start_date | string |
Timestamp indicating when the scan started. Format: YYYY-MM-DD hh:mm:ss.s Example: 2020-06-08 00:19:34.0
|
.. scan_end_date | string |
Timestamp indicating when the scan finished. Format: YYYY-MM-DD hh:mm:ss.s Example: 2020-06-09 00:19:34.0
|
.. vulnerability_status | string |
Vulnerability status of the domain. Possible values:
|
.. notification_status | string |
Notification settings for vulnerability assessments that you request for this order. Possible values:
|
.. critical_vulnerabilities_count | int | Number of critical vulnerabilities found. |
.. severe_vulnerabilities_count | int | Number of severe vulnerabilities found. |
.. moderate_vulnerabilities_count | int | Number of moderate vulnerabilities found. |
.. is_download_available | bool |
Whether a PDF report with assessment results is available for download. To download the assessment results, use the Download results endpoint. |
.. is_rescan_available | bool | Whether you can queue the domain to be rescanned. |
.. is_site_enabled | bool | Whether scans are enabled for this domain. |
page | object |
Details about results. Modified using URL query strings. |