Cancellation

Cancel a dispatch using the dispatch_id or multiple tasks within a workflow using the task_ids

covalent._results_manager.results_manager.cancel(dispatch_id, task_ids=None, dispatcher_addr=None)

Cancel a running dispatch.

Parameters

• dispatch_id (str) – The dispatch id of the dispatch to be cancelled.

• task_ids (Optional[List[int]]) – Optional, list of task ids to cancel within the workflow

• dispatcher_addr (Optional[str]) – Dispatcher server address, if None then defaults to the address set in Covalent’s config.

Return type

str

Returns

Cancellation response

Examples

• Cancel a running workflow