Skip to content
Proud to collaborate with Microsoft for Startups

connection.query ​

List cloud connections for an organization

Query cloud connections for an organization.

Inputs:

  • organization_uuid: UUID of the organization (required)
  • filters: Filter criteria - connection_type, name, config (optional)

Outputs (terminal state_data):

  • organization_uuid: str
  • filters: dict
  • connections: list of connection dicts (uuid-keyed; no integer ids)
  • count: int
  • error: str | None (only on failure)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-connection
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization to query
filtersjsonNo—A JSON OBJECT of filter criteria — the keys go INSIDE this object, not at the top level. Supported keys: connection_type, name, and config. Example: {"filters": {"connection_type": "neon"}}. Narrow on a config dimension with {"filters": {"config": {"auth_mode": "distributed"}}} — only allowlisted keys are filterable. Do NOT pass connection_type as a top-level input.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input
filtersjsonNo—Filter criteria echoed from input
connectionslistNo—List of connection dicts (uuid-keyed)
countintegerNo—Number of connections returned
errorstringNo—Error message when query 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.query",
  "initial_data": {
    "organization_uuid": "value"
  }
}