API reference

Simulations

Testing a new policy version on historical cases.

Create a policy simulation

POST/v1/policy-simulations

Scopes: policies:simulate
Required header: Idempotency-Key

Request body`SimulationCreate`

Field	Type	Required
`policy_id`	`string (uuid)`	yes
`ruleset_id`	`string (uuid)`	yes
`fixture_manifest_id`	`string (uuid)`	yes
`fixture_manifest_sha256`	`string`	yes

Responses

202Simulation
400
401
403
404
409
412
413
415
422
428
429
503

Get a policy simulation

GET/v1/policy-simulations/{simulation_id}

Scopes: policies:read

Parameters

Field	Type	Required
`simulation_id`path	`string (uuid)`	yes

Responses

200Simulation
400
401
403
404
409
412
413
415
422
428
429
503