POST /scanner/scanprofiles/{profileid}/start

Initiates a request to start an already created scanProfile. The request takes one parameter - scanProfileId, and one optional parameter - ips. To get a list of scanProfileIds, simply get a list of the current scan profiles by initiating a 'profiles' request on the scanner endpoint. The scanProfileId will be validated and an appropriate message returned.

Table 1. POST /scanner/scanprofiles/{profileid}/start resource details
MIME Type

text/plain

Table 2. POST /scanner/scanprofiles/{profileid}/start request parameter details
Parameter Type Optionality Data Type MIME Type Description

profileid

path

Required

String

text/plain

The unique id of the scan profile we want to start
Table 3. POST /scanner/scanprofiles/{profileid}/start request body details
Parameter Data Type MIME Type Description Sample

ips

JSON

application/json

null

null
Table 4. POST /scanner/scanprofiles/{profileid}/start response codes
HTTP Response Code Unique Code Description

202

The scan has been successfully started

422

1005

Occurs if the user does not have permission to start a scan, or the scan is in progress

500

1030

Occurs when an attempt is made to start a scan when certain conditions are not met, or when too many scan requests have been made

Response Description

An indicator of whether the scan has been started successfully or not.

Response Sample


String