Create remediation scan

Creates a remediation scan configuration. For more information and request body examples, see Manage Remediation Scans.

Note: Tenable Vulnerability Management limits the number of scans you can create to 10,000 scans. Tenable recommends you re-use scheduled scans instead of creating new scans. An HTTP 403 error is returned if you attempt to create a scan after you have already reached the scan limit of 10,000.

Requires the Scan Operator [24] user role or the VM.VM_REMEDIATION.VM_REMEDIATION.CREATE custom role privilege. See Roles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Specifies the UUID for the Tenable-provided remediation scan template to use. Use the List templates endpoint with a type of remediation to find remediation scan template UUIDs.

settings
object
required

Compliance output settings controlling result format and timeouts. Available in Advanced scan templates.

credentials
object

An object that specifies credential parameters that enable a scanner to authenticate a connection to a target host. For more information about using managed credentials with the Tenable Vulnerability Management API, see Manage Credentials.

plugins
object

Specifies plugin families and individual plugins to include or exclude from the scan. Each property in this object represents a plugin family (keyed by family name). Use the List plugin families endpoint to get a list of available plugin families. Use the List plugins in family endpoint to find individual plugins within a family.

For detailed guidance on configuring plugins, including how to use mixed status, lock states, and common configuration patterns, see Configure Scan Plugins.

Note: The property names in this object are dynamic — each key corresponds to a plugin family name (for example, Misc., Web Servers, Windows, DNS). The example below shows multiple families with different configurations.

enabled_plugins
array of strings

Specifies a list of plugin IDs to add to a remediation scan. You can use the List plugin families and List plugins in family endpoints to find plugin IDs.

Note: This parameter provides a simplified alternative to the full plugins object for remediation scans. For more information, see Manage Remediation Scans.

enabled_plugins
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Returned under the following conditions:

  • If your request message is missing a required parameter.
  • If your request was for a remediation scan and it included a user-defined template. User-defined templates are invalid for remediation scans.

403

Returned if you attempt to create a scan after you have already reached the scan limit of 10,000. Tenable recommends you re-use scheduled scans instead of creating new scans.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/html