Soft delete a flow execution
Soft delete a flow execution by marking it as deleted.
This endpoint performs a soft delete by setting the execution status to 'deleted'. The execution record remains in the database but is excluded from list operations and cannot be retrieved through standard endpoints.
Context: - Soft delete preserves audit trail and historical data - Does NOT stop running workflows (use cancel endpoint for that) - Deleted executions do not appear in GET /flow-executions list - Operation is idempotent - deleting already deleted execution succeeds - Deletion is permanent - no undelete functionality exists
Behavior: - Updates execution status to 'deleted' in database - Maintains all execution data for audit purposes - Removes from user-facing list queries - Does not affect related task executions or outputs - Triggers WebSocket notification for status change
Use Cases: - Remove test executions from production environment - Clean up failed executions no longer needed - Archive old executions while preserving data
Important Notes: - To stop a RUNNING workflow, use cancel endpoint (not yet implemented) - Soft delete does not free up workflow resources - Consider hard delete for GDPR compliance (requires database migration)
Related Endpoints: - GET /flow-executions - List excludes deleted executions - POST /flow-executions - Create new execution
Header Parameters
Path Parameters
UUID of the flow execution to soft delete. Must be owned by your organization.
Response
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.
Show child attributes
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.
Show child attributes
Response Attributes
Show child attributes
Response Attributes
Standard error detail structure.
This model matches the error format returned by the centralized exception handlers in app/api/errors/handlers.py.