6ef1ea32ff13

latestOpenAPI 3.1.02026-08-04197263.3 KB

Get Policy By Id

Get a policy by ID.

Docs: Guide | API Reference

Raises: ResourceNotFoundError: If the policy does not exist.

get/policies/{policy_id}

Path parameters

policy_idstring required

Response

Successful Response

idstring required
namestring required
descriptionstring nullable
rulesobject required
rule_modesobject
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
is_presetboolean
created_atstring date-time nullable
updated_atstring date-time nullable