Skip to main content
Creates a new simulation run plan. To run a simulation, use POST /v1/simulation/run instead: it starts a run from a plan or from an inline configuration, and takes runtime variables. Create a plan here when you want a reusable, named one to run later. Send template instead of a full configuration to save one of the built-in templates as a plan. It takes the same fields as the template variant of POST /v1/simulation/run, builds the same plan, and never starts it. To compare one property, attach the flow once and send comparisonProperty with the comparisonValues to run: the plan attaches the flow once per value.
Calls POST /v1/simulation/plan

​
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 name, direction, maxSimulationDurationSeconds, agentEndpoints
​
object
Requires template, agentEndpoints, direction

​
Example

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