Terminate Workflow

Terminates a running workflow. A reason must be provided that is captured as the termination reason for the workflow.

Input Payload

Attribute	Description
workflowId	The unique identifier of the workflow to be terminated.

API Endpoint

DELETE /workflow/{workflowId}

Client SDK Methods

Java

void terminateWorkflow(String workflowId, String reason)

Go

func (e *WorkflowExecutor) Terminate(workflowId string, reason string) error

Python

WorkflowResourceApi.terminate1(self, workflow_id, **kwargs)

C#

void WorkflowResourceApi.Terminate(string workflowId, string reason = null, bool? triggerFailureWorkflow = null)

JavaScript

WorkflowExecutor.terminate(
    workflowId: string,
    reason: string,
): CancelablePromise<any>

Typescript

WorkflowExecutor.terminate(
    workflowId: string,
    reason: string,
): CancelablePromise<any>

Clojure

(workflow-resource/terminate-workflow [options workflow-id & args])