FlowsInterfaceTerminateMessage

HTTP API schema

Stop a running flow, optionally gracefully and with cleanup.

FlowsInterfaceTerminateMessage fields

flowIdstringRequired

Unique identifier for the flow to terminate

minLength: 1

reasonstringRequired

Reason for termination

Allowed values: USER_REQUEST, ERROR, TIMEOUT, COMPLETION, CANCELLATION.

gracefulboolean

Whether to perform graceful termination

Default: true

cleanupboolean

Whether to perform cleanup operations

Default: true

metadataobject

Additional metadata for the termination