Search remediation goals

post

https://cloud.tenable.com/remediation/goal/search

Returns a list of remediation goals that match the specified search criteria. For more information, see View Remediations in the Tenable Vulnerability Management User Guide.

Requires the Basic [16] user role or the VM.VM_REMEDIATION.VM_REMEDIATION.READ custom role privilege. See Roles.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the search criteria for the remediation goals list.

filter

object

Filters results to the remediation goals matching the specified criteria.

limit

integer

≥ 1

Specifies the maximum number of remediation goals to return. The minimum value is 1.

string

Specifies the pagination token from the pagination.next property of a previous response, to retrieve the next page of results.

sort

array of objects

Specifies the properties and directions used to sort the results. Specify asc for ascending or desc for descending. Supplying several objects sorts by each property in turn.

Supported properties:

name — The name of the remediation goal.
description — The description of the remediation goal.
status — The current status of the remediation goal.
type — The type of the remediation goal.
progress — The completion progress of the remediation goal.
minimumpercentage — The minimum percentage required to meet the remediation goal.
startdate — The date on which the remediation goal starts.
duedate — The date on which the remediation goal is due.
create_tstamp — The date and time when the remediation goal was created.
update_tstamp — The date and time when the remediation goal was last updated.

Note: Supplying a property that cannot be sorted returns a 400 response.

sort

fields

string

Specifies the properties to include for each record.

findingsType

string

Specifies the type of findings to evaluate.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Returned if the request contains invalid parameters or malformed data.

200Returned if the remediation goals were retrieved successfully.

401Returned if the request is missing valid credentials.

429Returned if you attempt to send too many requests in a specific period of time.

500Returned if Tenable encountered an internal error.