v1

latestOpenAPI 3.1.02026-08-04197263.3 KB

Update Policy

Update an existing policy.

Only provided fields will be updated. Omit fields to leave them unchanged. Preset policies cannot be modified. Requires admin role.

Docs: Guide | API Reference

Raises: ResourceNotFoundError: If the policy does not exist. PresetPolicyModificationError: If attempting to modify a preset policy. AdminRequiredError: If user is not an admin.

put/policies/{policy_id}

Path parameters

policy_idstring required

Request body

namestring nullable

descriptionstring nullable

categoriesobject nullable

rule_modesobject nullable

modestring nullable

pre_violation_thresholdnumber nullable

pre_jb_thresholdnumber nullable

post_violation_thresholdnumber nullable

post_violation_jb_thresholdnumber nullable

scanners_configobject nullable

block_messagestring nullable

Response

Successful Response

idstring required

namestring required

descriptionstring nullable

rulesobject required

rule_modesobject