Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /scanner/scanprofiles

Retrieves all of the currently created scan profiles. No parameters are required and the following information should be retrieved for each scan profile - scanProfileId - name - description - scanType - scannerName - schedule - status - progress - endTime - duration

Table 1: GET /scanner/scanprofiles Resource Details

MIME Type

application/json

Table 2: GET /scanner/scanprofiles Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 3: GET /scanner/scanprofiles Response Codes

HTTP Response Code

Unique Code

Description

200

 

The list of scan profiles was successfully returned

500

1030

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

Response Description

The list of scan profiles currently configured in QVM

Response Sample