Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

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

 

Updates the status of a vulnerability instance saved search.

Updates the status of a vulnerability instance saved search.

Table 1: POST /qvm/saved_searches/vuln_instances/{task_id}/status Resource Details

MIME Type

application/json

Table 2: POST /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

Required. The ID of the task to update.

status

query

Optional

String

text/plain

Optional. The only accepted value is CANCELLED. If this value is provided, the search is cancelled.

retention_

period_in_

days

query

Optional

Number (Integer)

text/plain

Optional. Set the data retention period in days for the results. Accepted values 0 - 14. Use 0 to delete a result at the next clean up cycle. Default data retention period is 2 days.

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: POST /qvm/saved_searches/vuln_instances/{task_id}/status Response Codes

HTTP Response Code

Unique Code

Description

200

 

The request to retrieve the list of vulnerability instance saved searches completed successfully.

403

1009

You do not have the proper capabilities to retrieve the Vulnerability Instance Saved Search.

404

1002

Resource not found.

409

1004

The current status of the search prevented the task from being cancelled.

422

1005

A request parameter is not valid.

500

1020

An error occurred while retrieving status.

Response Description

Returns the status of the selected Vulnerability Instance search.

Response Sample