latestOpenAPI 3.1.02026-08-223321,1001.6 MB

2134ebffd1ef

Stop Background Task

Stop a running background task.

Looks up the task type from the database and sends the appropriate abort signal to the Temporal workflow.

post/background-tasks/stop

task_idstring required

Primary key of the background task to stop

Successful Response

workflow_idstring required

Temporal workflow ID that was targeted

task_typestring required

Type of background task

abortedboolean required

Whether the abort signal was sent successfully

errorstring nullable

Error message if something went wrong