Update Policy

put

https://jf.example.com/xray/api/v1/policies/{name}

Updates an existing policy. The policy name in the URL path is authoritative — it overrides any name field in the request body. The full policy definition must be provided (this is a full replacement, not a partial update).

Requires the "Manage Policies" role to be set on the User or Group level. For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can update a policy in the scope of a project by using the additional query parameter projectKey.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

name

string

required

The name of the policy to update. This value takes precedence over any name in the request body.

Query Params

projectKey

string

When provided, the update is scoped to the specified project. Requires Xray 3.21.2+ with Projects enabled.

Body Params

Request body for creating or updating a policy. A policy defines rules that determine how Xray identifies and acts on issues found during scanning. Each policy has a type (security, license, or operational_risk) and contains one or more rules. Each rule has criteria (what to match) and actions (what to do when matched).

name

string

required

Name of the policy. Must be unique across the system (or within a project when using projectKey).

description

string

Optional free-text description of the policy.

type

string

enum

required

The policy type. Determines which criteria fields are available in the rules.

Allowed:

rules

array of objects

required

One or more rules that define the policy behavior. Each rule specifies criteria to match and actions to take when matched.

rules*

Responses

200Policy updated successfully.

400Policy name is empty or the policy is not valid.

403Permission denied, or attempting to use a license-type policy without the required license entitlement.

404Policy not found.

415Failed to parse the request body.

500Internal server error while updating the policy.