NInimbleway
Jobs

Cancel Run

Changed on

Cancel Run

post/v1/jobs/runs/{run_id}/cancel

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/jobs/runs/{run_id}/cancel
  • Auth
    • HTTP bearer
    • or API key in cookie token

Path parameters

run_idstring required

Response

Successful Response

idstring required

Identifier of the cancelled run.

status'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING' required

Run status after cancellation.

Changes

  • d4e4f170f4f4Revision changes
    • warning

      deleted the cookie request parameter token

    • info

      api operation id cancel_run_v2_jobs_runs__run_id__cancel_post removed and replaced with cancel_run_public_v1_api_v1_public_jobs_runs__run_id__cancel_post

    • info

      the endpoint scheme security APIKeyCookie was added to the API

    • info

      the endpoint scheme security HTTPBearer was added to the API

    • info

      endpoint deprecated

  • 2562e655b8f2Revision changes
    • info

      endpoint added