policies

Set Policy Agent Mode Route

Changed on

Run the policy in its own mode for one agent it covers: enforced for the agents in one region, in Monitor for another's. Only that agent gets a new config version.

put/api/v1/policies/{policy_id}/agents/{agent_id}/mode

Request

Path parameters

policy_idstring uuid required
agent_idstring uuid required

Headers

Authorizationstring nullable
X-Request-IDstring nullable

Request body

enforcement_mode'enforce' | 'monitor' required

Response

Successful Response

idstring uuid required
agent_idsstring[]
agent_modesobject
org_idstring uuid required
owner_idstring uuid nullable required
namestring required
categorystring required
summarystring required
regostring required
enabledboolean required
stagestring required
enforcement_modestring
template_idstring nullable
template_versioninteger nullable
framework_tagsstring[] nullable
parameter_valuesobject nullable
versioninteger
baseline_targetobject nullable
created_atstring date-time required
updated_atstring date-time required
warningsstring[] required
groupstring required
template_controls_outdatedboolean required

Changes