Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20

Maximum number of plan jobs to return (default: 20, max: 50)

Required range: 1 <= x <= 50
Example:

20

after
string<uuid>

Cursor for pagination - use the nextCursor value from a previous response

Example:

"550e8400-e29b-41d4-a716-446655440000"

status
enum<string>

Filter by plan job status (PENDING, CREATING_SNAPSHOTS, CREATING_SIMULATIONS, RUNNING_SIMULATIONS, ENDING_SIMULATIONS, COMPLETED, FAILED, TIMED_OUT, CANCELLED, CANCELLING)

Available options:
PENDING,
QUEUED,
CREATING_SNAPSHOTS,
CREATING_SIMULATIONS,
RUNNING_SIMULATIONS,
COMPLETED,
FAILED,
TIMED_OUT,
CANCELLED,
CANCELLING,
ENDING_SIMULATIONS
Example:

"COMPLETED"

simulationRunPlanId
string<uuid>

Filter by simulation run plan ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

labelId
string<uuid>

Filter by label ID attached to the plan job. Use this if you know the label ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

labelName
string

Filter by label name attached to the plan job. More user-friendly alternative to labelId. Case-insensitive.

Example:

"production-ready"

Response

Paginated list of simulation plan jobs

Paginated list of simulation run plan jobs

data
object[]
required
pagination
object
required