Skip to content
Proud to collaborate with Microsoft for Startups

connection.get ​

Get a single cloud connection by UUID

Get a single cloud connection by UUID.

Inputs:

  • organization_uuid: UUID of the organization (required)
  • connection_uuid: Connection UUID (required)

Outputs (terminal state_data):

  • organization_uuid: str
  • connection_uuid: str
  • connection: dict | None (uuid-keyed; no integer id)
  • error: str | None (only on failure)

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 fetch

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input
connection_uuiduuidNo—Connection UUID echoed from input
connectionjsonNo—Connection record (uuid-keyed) or null if not found
errorstringNo—Error message when fetch failed
failure_reasonstringNo—Engine-stamped failure reason
failure_typestringNo—Engine-stamped failure category
failed_actionstringNo—Engine-stamped action that raised
failed_at_statestringNo—Engine-stamped state name when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerstringNo—Engine-stamped layer index (DAG path)
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

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