Skip to main content

Get scan 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 endpoint.

Example requests & responses

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.

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:

  • filters[domain]

  • filters[status]: Use secure, vulnerable, in_progress, not_started, unreachable, or unavailable.

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:

  • status

  • domain

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

Response parameters

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:

  • SECURE: No vulnerabilities detected.

  • VULNERABLE: Vulnerabilities detected.

  • IN_PROGRESS: Scanning is in progress.

  • NOT_STARTED: The domain is queued for scanning.

  • UNREACHABLE: The scanning service failed to reach your server.

  • UNAVAILABLE: The scanning service is unavailable.

.. notification_status

string

Notification settings for vulnerability assessments that you request for this order.

Possible values:

  • disabled: Never send email notifications.

  • always_notify: Send notification emails after every completed scan.

  • notify_only_alerts: Only send email notifications when a scan finds vulnerabilities.

.. 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.