---
title: "Get scan details"
source_url: https://dev.digicert.com/certcentral-apis/services-api/vulnerability-assessments/get-scan-details.html
api_method: GET
api_endpoint: "/services/v2/vulnerability-assessment/{{order_id}}/details"
api_url: "https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/details"
---

**GET** `https://www.digicert.com/services/v2/vulnerability-assessment/{{order_id}}/details`

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](https://dev.digicert.com/md/certcentral-apis/services-api/orders/list-orders.md) endpoint.

## Example requests & responses

**cURL**

```bash
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}}'
```

**Python**

```python
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'))
```

**Go**

```go
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))
}
```

**NodeJS**

```javascript
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);
});
```


**200 OK**

```json
{
    "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
    }
}
```

**404 Not Found**

```json
{
  "errors": [
    {
      "code": "not_found|route",
      "message": "The specified route was not found."
    }
  ]
}
```

**403 Forbidden (Access permission)**

```json
{
  "errors": [
    {
      "code": "access_denied",
      "message": "You do not have permission to manage this request."
    }
  ]
}
```

**400 Bad Request (Invalid format)**

```json
{
  "errors": [
    {
      "code": "va_bad_request",
      "message": "API request invalid. Validate allowed parameters and try again."
    }
  ]
}
```

**400 Bad Request (Invalid order status)**

```json
{
  "errors": [
    {
      "code": "va_not_eligible_order",
      "message": "Invalid order status. Order must be issued, not revoked, expired, or pending."
    }
  ]
}
```

**400 Bad Request (Invalid product type)**

```json
{
  "errors": [
    {
      "code": "va_not_eligible_product",
      "message": "Invalid certificate type. Vulnerability assessment is only available for Secure Site EV and Secure Site Pro certificates."
    }
  ]
}
```


## 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](https://dev.digicert.com/md/certcentral-apis/services-api.md#filters-sorting-and-pagination-parameters).

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Req/Opt</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>filters[<code>{{property_name}}</code>]</td>
<td>optional</td>
<td>string</td>
<td>Filters results by the specified property.<br>Replace <code>{{property_name}}</code> in your request with the property to use for filtering. This endpoint supports filtering by the following properties:<br><ul><li><code>filters[domain]</code></li><li><code>filters[status]</code>: Use <code>secure</code>, <code>vulnerable</code>, <code>in_progress</code>, <code>not_started</code>, <code>unreachable</code>, or <code>unavailable</code>.</li></ul></td>
</tr>
<tr>
<td>sort</td>
<td>optional</td>
<td>string</td>
<td>Sorts results by the value of one or more properties.<br>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 (<code>-</code>).<br>To sort by multiple properties, separate the name of each property with a comma. Sort hierarchy matches the order of properties in this list.<br>This endpoint supports sorting by the following properties:<br><ul><li><code>status</code></li><li><code>domain</code></li></ul></td>
</tr>
<tr>
<td>offset</td>
<td>required</td>
<td>int</td>
<td>Index of the first result to include in the response.<br>Default: 0</td>
</tr>
<tr>
<td>limit</td>
<td>required</td>
<td>int</td>
<td>Total number of results to include in the response.<br>Max: 1000</td>
</tr>
</tbody>
</table>

## Response parameters

<table class="params-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>domains_scan_details</td>
<td>array</td>
<td>List of objects with vulnerability assessment details for domains on the scanned order.</td>
</tr>
<tr>
<td>.. host_name</td>
<td>string</td>
<td>The scanned domain.</td>
</tr>
<tr>
<td>.. scan_start_date</td>
<td>string</td>
<td>Timestamp indicating when the scan started.<br>Format: YYYY-MM-DD hh:mm:ss.s<br>Example: 2020-06-08 00:19:34.0</td>
</tr>
<tr>
<td>.. scan_end_date</td>
<td>string</td>
<td>Timestamp indicating when the scan finished.<br>Format: YYYY-MM-DD hh:mm:ss.s<br>Example: 2020-06-09 00:19:34.0</td>
</tr>
<tr>
<td>.. vulnerability_status</td>
<td>string</td>
<td>Vulnerability status of the domain.<br>Possible values:<br><ul><li>SECURE: No vulnerabilities detected.</li><li>VULNERABLE: Vulnerabilities detected.</li><li>IN_PROGRESS: Scanning is in progress.</li><li>NOT_STARTED: The domain is queued for scanning.</li><li>UNREACHABLE: The scanning service failed to reach your server.</li><li>UNAVAILABLE: The scanning service is unavailable.</li></ul></td>
</tr>
<tr>
<td>.. notification_status</td>
<td>string</td>
<td>Notification settings for vulnerability assessments that you request for this order.<br>Possible values:<br><ul><li>disabled: Never send email notifications.</li><li>always_notify: Send notification emails after every completed scan.</li><li>notify_only_alerts: Only send email notifications when a scan finds vulnerabilities.</li></ul></td>
</tr>
<tr>
<td>.. critical_vulnerabilities_count</td>
<td>int</td>
<td>Number of critical vulnerabilities found.</td>
</tr>
<tr>
<td>.. severe_vulnerabilities_count</td>
<td>int</td>
<td>Number of severe vulnerabilities found.</td>
</tr>
<tr>
<td>.. moderate_vulnerabilities_count</td>
<td>int</td>
<td>Number of moderate vulnerabilities found.</td>
</tr>
<tr>
<td>.. is_download_available</td>
<td>bool</td>
<td>Whether a PDF report with assessment results is available for download. To download the assessment results, use the Download results endpoint.</td>
</tr>
<tr>
<td>.. is_rescan_available</td>
<td>bool</td>
<td>Whether you can queue the domain to be rescanned.</td>
</tr>
<tr>
<td>.. is_site_enabled</td>
<td>bool</td>
<td>Whether scans are enabled for this domain.</td>
</tr>
<tr>
<td><a href="https://dev.digicert.com/md/certcentral-apis/services-api/structures.md#page-details-object">page</a></td>
<td>object</td>
<td>Details about results. Modified using URL query strings.</td>
</tr>
</tbody>
</table>