runs

Cancel run

Cancels a run that is scheduled, queued or running.

Only runs with status scheduled, queued or started can be cancelled; other statuses return 400. A running run is marked cancelled immediately and its agent stops shortly after.

Required permission: runs.cancel.

post/v1/projects/{project_id}/runs/{run_id}/cancel

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/runs/{run_id}/cancel
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

run_idstring uuid required

Run ID from GET /runs.

Response

Successful Response

okboolean required

Whether the operation succeeded.

message'Run cancelled' | 'Cancel signal sent' required

Run cancelled when a scheduled or queued run was cancelled before it started. Cancel signal sent when the run was already executing and is being stopped.

Changes

No recorded changes to this operation across all 2 revisions of this API.