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 ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-connection |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the organization that owns the connection |
connection_uuid | uuid | Yes | — | UUID of the connection to soft-delete |
actor | string | No | — | ID of the user/agent initiating the delete |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | UUID of the soft-deleted connection |
deleted_at | string | No | — | ISO-8601 timestamp of the soft-delete |
already_deleted | boolean | Yes | — | True when the row was already soft-deleted before this run |
deleted | boolean | Yes | — | True when this run mutated the row |
failure_reason | string | No | — | Engine-stamped: human-readable failure reason |
failure_type | string | No | — | Engine-stamped: failure category |
failed_action | string | No | — | Engine-stamped: action method that raised |
failed_at_state | string | No | — | Engine-stamped: state name when the failure occurred |
failed_step | string | No | — | Engine-stamped: name of the step that failed (DAG workflows) |
failed_layer | integer | No | — | Engine-stamped: layer index that failed (DAG workflows) |
error | string | No | — | Engine-stamped: error message on the failure envelope |
error_type | string | No | — | Engine-stamped: exception class name on the failure envelope |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Soft-delete connection |
completed | No | Yes | Yes | — | Deleted |
failed | No | Yes | No | — | Delete failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
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"
}
}