Cancel Run

curl --request POST \
  --url https://sdk.nimbleway.com/v1/jobs/runs/{run_id}/cancel \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>"
}

POST

jobs

runs

{run_id}

cancel

Cancel Run

curl --request POST \
  --url https://sdk.nimbleway.com/v1/jobs/runs/{run_id}/cancel \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>"
}

Authorization

string

header

required

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

run_id

string

required

token

string | null

Successful Response

Result of cancelling a run.

string

required

Identifier of the cancelled run.

Pattern: ^run_[1-9][0-9]*$

status

enum<string>

required

Run status after cancellation.

Available options:

PENDING,

RUNNING,

SUCCESS,

FAILED,

CANCELLED,

TIMEOUT,

WARNING

⌘I