Skip to main content

signaloid-cli tasks cancel

Cancel a running task.

Synopsis​

signaloid-cli tasks cancel --task-id <id>

Options​

OptionRequiredDescription
--task-id <id>YesTask ID to cancel

Description​

Cancels a task that is currently running or queued. The task will be terminated and its status will change to cancelled. Any partial results may be lost.

Examples​

signaloid-cli tasks cancel --task-id tsk_abc123

Output:

{
  "TaskID": "tsk_abc123",
  "cancelled": true
}

Notes​

  • Only tasks in non-terminal states can be cancelled
  • Cancelled tasks cannot be resumed
  • The command is idempotent - cancelling an already cancelled task will succeed
  • Output may still be available for cancelled tasks, but may be incomplete

Troubleshooting​

Cannot Cancel Completed Task​

Problem: Attempting to cancel a task that has already completed.

Solution: Check the task status first with signaloid-cli tasks status --task-id $TASK_ID. Tasks in terminal states (completed, cancelled, stopped) cannot be cancelled.

See Also​

Last updated on