cancel_flight_run

Preview

This feature is in preview and is subject to change.

Cancel an in-progress run of a Flight, identified by the Flight UUID and the sequential run_number (from list_flight_runs).

Returns canceled: true on a successful transition. Calling on an already-terminal run (SUCCEEDED, FAILED, CANCELLED) or one that doesn't exist returns a tool error.

The SQL equivalent is MD_CANCEL_FLIGHT_RUN.

Input parameters

Parameter	Type	Required	Description
id	string (UUID)	Yes	The Flight UUID.
run_number	integer	Yes	Sequential run number to cancel.

Output schema

{
  "success": boolean,
  "canceled": boolean,
  "error": string
}

Example usage

{ "id": "80000000-0000-0000-0000-000000000001", "run_number": 42 }

Related

• list_flight_runs — Find runs that are still in progress.
• run_flight — Trigger a new run.
• MD_CANCEL_FLIGHT_RUN — SQL equivalent.