Skip to main content
POST
Stop all workflow executions

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Needed only when the server has a key configured.

Path Parameters

sessionId
string
required

Session ID

workflowId
string
required

Workflow ID

Query Parameters

mode
enum<string>
default:DRAIN

DRAIN lets in-flight work finish (default), CANCEL cancels it, KILL stops at once

Available options:
DRAIN,
CANCEL,
KILL

Response

200 - */*

OK

Unified API response wrapper for both success and error responses. Success responses include data field; error responses include error, path, and errors fields.

timestamp
string<date-time>

The time the response was generated

status
integer<int32>

The HTTP status code

Example:

200

message
string

A human-readable message

Example:

"Operation successful"

data
object

The response data

error
string

The HTTP status error name

Example:

"Bad Request"

path
string

The request path

Example:

"/api/files"

errors
object[]

The list of field validation errors