Skip to main content
Returns a paginated list of simulation run plan jobs. Filter by status, plan ID, or label to find specific simulation batches.
Calls GET /v1/simulation/plan/jobs

​
Options

​
integer
Maximum number of plan jobs to return (default: 20, max: 50).
​
string
Cursor for pagination - use the nextCursor value from a previous response.
​
string
Filter by plan job status (PENDING, QUEUED, CREATING_SNAPSHOTS, CREATING_SIMULATIONS, PREPARING_CAPACITY, RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING, ENDING_SIMULATIONS). One of PENDING, QUEUED, CREATING_SNAPSHOTS, CREATING_SIMULATIONS, PREPARING_CAPACITY, RUNNING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING, ENDING_SIMULATIONS
​
string
Filter by simulation run plan ID.
​
string
Filter by label ID attached to the plan job. Use this if you know the label ID.
​
string
Filter by label name attached to the plan job. More user-friendly alternative to labelId. Case-insensitive.

​
Example

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