ROroarkhq
Simulation Run Plan Job

Cancel a simulation plan job

Changed on

Stops a run that has not finished yet. Already-finished runs are left alone.

Intended for CI: when a pipeline is cancelled or superseded, cancelling the run stops it placing calls you no longer need. Safe to call more than once.

post/v1/simulation/plan/job/{jobId}/cancel

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/plan/job/{jobId}/cancel
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

Simulation run plan job ID

Response

The run is cancelled, or had already finished

Example response

{
  "data": {
    "simulationRunPlanJobId": "7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
    "status": "CANCELLED",
    "cancelled": true
  }
}

Changes