GET /scanner/scanprofiles

date_range 24-May-22

SUMMARY 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:
GET /scanner/scanprofiles resource details
MIME Type
application/json

Table 2: GET /scanner/scanprofiles request parameter details:
GET /scanner/scanprofiles request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
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.
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.

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

content_copy zoom_out_map
[
    {
        "description": "String",
        "duration": {
            "days": 42,
            "hours": 42,
            "microSeconds": 42,
            "minutes": 42,
            "months": 42,
            "seconds": 42.5,
            "type": "String",
            "value": "String",
            "wholeSeconds": 42,
            "years": 42
        },
        "endTime": {
            "date": 42,
            "day": 42,
            "hours": 42,
            "minutes": 42,
            "month": 42,
            "seconds": 42,
            "time": 42,
            "timezoneOffset": 42,
            "year": 42
        },
        "progress": 42,
        "scanProfileId": 42,
        "scanProfileName": "String",
        "scanType": "String",
        "scannerName": "String",
        "schedule": "String",
        "status": "String"
    }
]

arrow_backward PREVIOUS POST /scanner/profiles/start

NEXT arrow_forward POST /scanner/scanprofiles

REST API Version 17.0 References

ON THIS PAGE

GET /scanner/scanprofiles

Response Description

Response Sample

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry