Update policy

put

https://cloud.tenable.com/policies/{policy_id}

Updates an existing policy (scan template). Tenable preserves any setting omitted from the request, so a request can contain only the settings that change.

Note: Policies are referred to as scan templates in the user interface. The term policy is only used by the API. The two terms refer to the same feature.

Requires the Standard [32] user role and the Can Execute [32] scan template (policy) permission. Alternatively, requires the VM.VM_SCAN.VM_SCAN_USER_TEMPLATE.EDIT custom role privilege. See Roles and Permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

policy_id

int32

required

Specifies the unique identifier of the policy to update.

Body Params

uuid

string

Specifies the unique identifier (UUID) of the Tenable-provided template the policy is based on. To get the available template UUIDs, use List templates with a type of policy. Tenable ignores this property when updating a policy, because a policy cannot be moved to a different template after it is created.

settings

object

Specifies the scan settings to change. Tenable preserves any setting omitted from the request and discards any setting that the template of the policy does not define. For the meaning of a setting that is not listed here, see the request body of Create scan, or get the form definition for the template with Get template details.

plugins

object

Specifies the plugin families to enable or disable, keyed by plugin family name. A plugin family omitted from the request keeps its current status. Only templates that expose plugin selection, such as the Advanced Network Scan template, accept this property.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

403

Returned if you do not have the required permissions to update the policy (scan template).

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Returned if the configuration of the specified policy (scan template) was updated successfully.

400Returned if your request specified invalid parameters or if your request was improperly formatted.

401Returned if the API keys specified in your request are invalid.

404Returned if Tenable Vulnerability Management cannot find the specified policy (scan template).

429Returned if you attempt to send too many requests in a specific period of time. For more information, see Rate Limiting.

500Returned if an internal error occurred.