Update an existing policy

put

https://api.jfrog.com/unifiedpolicy/api/v1/policies/{policyId}

Update an existing policy with new configuration.
This endpoint allows updating any aspect of the policy including rules,
description, and other metadata.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

policyId

string

required

length between 4 and 20

^[0-9]*$

Policy identifier.

Body Params

Policy input object for create/update.

Policy data for create and update operations.
Contains the policy configuration without system-managed fields.

name

string

required

length between 1 and 225

^[a-zA-Z0-9_ -]*$

A unique name for JFrog resources.
Must be 1-225 alphanumeric characters, underscores, hyphens, and spaces.

description

string

length ≤ 2048

A human-readable description of the resource.
Optional field with a maximum length of 2048 characters. Can contain any characters.

enabled

boolean

required

if true policy is active, otherwise it is inactive.

mode

string

enum

required

Controls the behavior of unified policy, allowing it to run in a non-enforcing state.

Allowed:

action

required

Attributes defines the action a policy is applicable.

scope

required

Attributes defines when a policy is applicable.

rule_ids

array of objects

required

length between 1 and 1

A list of rule ids that the policy enforces.
Note: Currently limit to 1 rule per policy.

rule_ids*

waiver_request_config

string

enum

Defaults to manual

Controls how waiver requests targeting this policy are handled:

forbidden: waiver requests are rejected on creation.
manual: waiver requests are created as pending and require approval from a policy_manager (default).
auto_approved: waiver requests are automatically approved on creation.

Allowed:

Responses

Language

Credentials

Loading…

Response

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

application/json

200The request has succeeded.

400The request syntax was invalid or malformed, or validation failed.

401Authentication credentials are required or invalid.

403You do not have sufficient permissions to perform this action.

404The resource with the specified ID was not found.

409The request conflicts with the current state of the resource.

500An unexpected error occurred. Please contact support.