Sign in

v1

latestOpenAPI 3.1.02026-08-06330343826.1 KB
Scan

Site Scans

Starts a scan for the specified site.

post/api/3/sites/{id}/scans

Path parameters

idinteger required

The identifier of the site.

The identifier of the site.

Query parameters

overrideBlackoutboolean

Whether to request for the override of an scan blackout window.

Request body

assetGroupIdsobject[]

The asset groups that should be included as a part of the scan. Only asset groups assigned to the site can be specified for a scan. This value should be an array of integers representing the unique identifiers of the asset groups.

engineIdinteger

The identifier of the scan engine.

hostsstring[]

The hosts that should be included as a part of the scan. This should be a mixture of IP Addresses and Hostnames as a String array.

namestring

The user-driven scan name for the scan.

templateIdstring

The identifier of the scan template

Response

OK