Sign in
v1
protected
policies

Update Policy Rule

Partially update a policy rule.

patch/v1/workspaces/{workspace}/policies/{rule_id}

Path parameters

rule_idstring uuid required
workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Request body

conditionstring nullable
effect'allow' | 'deny' | 'cap' | 'approval' | 'safety' | 'egress'

What a rule does when it applies.

enabledboolean nullable
paramsobject nullable
priorityinteger nullable
subject_idstring nullable
subject_type'workspace' | 'agent' | 'user' | 'group'

The kind of subject a rule binds to.

targetstring nullable

Response

Successful Response

conditionstring nullable
effect'allow' | 'deny' | 'cap' | 'approval' | 'safety' | 'egress' required

What a rule does when it applies.

enabledboolean required
idstring required
paramsobject required
priorityinteger required
subject_idstring required
subject_type'workspace' | 'agent' | 'user' | 'group' required

The kind of subject a rule binds to.

targetstring required

Changes

Changed in 1 of the 45 revisions of this API.1