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.

Path Parameters

policy_id*Policy Id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for updating an existing policy (all fields optional).

name?|null

description?string|null

categories?|null

rule_modes?|null

mode?string|null

pre_violation_threshold?|null

pre_jb_threshold?|null

post_violation_threshold?|null

post_violation_jb_threshold?|null

scanners_config?|null

Response Body

`application/json`

curl -X PUT "https://example.com/policies/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "description": "string",  "rules": {    "property1": "string",    "property2": "string"  },  "rule_modes": {    "property1": "block",    "property2": "block"  },  "mode": "string",  "pre_violation_threshold": 0,  "pre_jb_threshold": 0,  "post_violation_threshold": 0,  "post_violation_jb_threshold": 0,  "scanners_config": {},  "is_preset": false,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Path Parameters

Request Body

Response Body

200application/json

422application/json

`application/json`

`application/json`