Skip to main content
Starts a simulation and returns the run. Send template to run one of the built-in templates: it supplies the metrics and checks, and for some templates the flows too, so the request only names the agent and the direction. Send plan to describe a simulation yourself and run it once. Send planId to run a plan you already have. template and plan both resolve to a run plan, returned as simulationRunPlanId. Add saveAsPlan to keep it, or read it back to see exactly what ran. A plan built from a template is a snapshot: retuning the template later never changes what that plan runs, which is what makes a saved one safe to pin in CI.
Calls POST /v1/simulation/run

Request body

This endpoint accepts one of several request shapes, so the body is supplied as JSON through --data or on standard input rather than as individual flags.
object
Requires plan
object
Requires planId
object
Requires template, agentEndpoints, direction

Example

Every command also takes the global options and sets one of the exit codes.