Get Policy By Id

Get a policy by ID.

Raises: ResourceNotFoundError: If the policy does not exist.

get/policies/{policy_id}

Request

Base URL
https://api.grayswan.ai
Auth
none declared
TypeScript
https://skmtc.dev/grayswan/apis/gray-swan-ai-api/docs/policies/:policy_id/get.ts
A function with typed inputs. Its response is checked against the schema.

policy_idstring required

Successful Response

idstring required

namestring required

descriptionstring nullable

rulesobject required

rule_modesobject

rule_block_messagesobject

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