Skip to content

FlowsInterfacePauseMessage

HTTP API schema

← HTTP API reference

Pause a running flow, optionally creating a checkpoint first.

FlowsInterfacePauseMessage fields

flowIdstringRequired

Unique identifier for the flow to pause

minLength: 1

reasonstringRequired

Reason for pausing

Allowed values: USER_REQUEST, RESOURCE_LIMIT, WAITING, MAINTENANCE.

checkpointboolean

Whether to create a checkpoint before pausing

Default: true

metadataobject

Additional metadata for the pause operation

View source specification ↗