Skip to content
Proud to collaborate with Microsoft for Startups

data.connection.soft_delete ​

Soft-delete a CloudConnection and scrub its secrets

Soft-delete a cloud connection.

Input: organization_uuid, connection_uuid, optional actor. Output in state_data: connection_uuid, deleted_at, already_deleted, deleted.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-connection
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization that owns the connection
connection_uuiduuidYes—UUID of the connection to soft-delete
actorstringNo—ID of the user/agent initiating the delete

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—UUID of the soft-deleted connection
deleted_atstringNo—ISO-8601 timestamp of the soft-delete
already_deletedbooleanYes—True when the row was already soft-deleted before this run
deletedbooleanYes—True when this run mutated the row
failure_reasonstringNo—Engine-stamped: human-readable failure reason
failure_typestringNo—Engine-stamped: failure category
failed_actionstringNo—Engine-stamped: action method that raised
failed_at_statestringNo—Engine-stamped: state name when the failure occurred
failed_stepstringNo—Engine-stamped: name of the step that failed (DAG workflows)
failed_layerintegerNo—Engine-stamped: layer index that failed (DAG workflows)
errorstringNo—Engine-stamped: error message on the failure envelope
error_typestringNo—Engine-stamped: exception class name on the failure envelope

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeSoft-delete connection
completedNoYesYes—Deleted
failedNoYesNo—Delete failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.connection.soft_delete",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value"
  }
}