Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /scanner/scanprofiles/{profileid}

SUMMARY Retrieves a scan profile for a given Scan Profile ID. The only parameter required is the Scan Profile ID. The following information about a scan profile will be returned - scanProfileId - name - description - scanType - scannerName - schedule - status - progress - endTime - duration

Table 1: GET /scanner/scanprofiles/{profileid} resource details:

GET /scanner/scanprofiles/{profileid} resource details

MIME Type

application/json

Table 2: GET /scanner/scanprofiles/{profileid} request parameter details:

GET /scanner/scanprofiles/{profileid} 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 need to retrieve information for

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.

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.

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.
Table 3: GET /scanner/scanprofiles/{profileid} response codes:

GET /scanner/scanprofiles/{profileid} response codes

HTTP Response Code Unique Code Description

200

The scan profile was successfully returned

500

1030

Occurs when an attempt is made to list a scan profile 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