GET /qvm/saved_searches/vuln_instances/{task_id}/status

Retrieves the current status of a vulnerability instance search that was initiated.

Retrieves the current status of a vulnerability instance search that was initiated.

Table 1. GET /qvm/saved_searches/vuln_instances/{task_id}/status resource details
MIME Type

application/json

Table 2. GET /qvm/saved_searches/vuln_instances/{task_id}/status request parameter details
Parameter Type Optionality Data Type MIME Type Description

task_id

path

Required

Number (Integer)

text/plain

null

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 /qvm/saved_searches/vuln_instances/{task_id}/status response codes
HTTP Response Code Unique Code Description

200

The request to retrieve the current status of the vulnerability instance search completed successfully.

404

1002

Resource not found.

500

1020

An error occurred while retrieving status.

Response Description

Returns the status of the selected vulnerability instance search.

Response Sample


{
    "id": 42,
    "retention_period_in_days": 42,
    "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>"
}