Appearance
<!-- generated by scripts/generate_docs.py — do not edit manually -->
connection.get
Get a single cloud connection by UUID
Get a single cloud connection by UUID.
Inputs:
- organization_id: Organization ID (required)
- connection_uuid: Connection UUID (required)
Outputs (terminal state_data):
- organization_id: int
- connection: dict | None
- error: str | None (only on failure)
Overview
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | Business |
| Version | 1.0 |
Input Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | integer | Yes | — | Organization ID |
connection_uuid | uuid | Yes | — | Connection UUID |
States
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
Transitions
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage
bash
POST /api/v1/workflows/connection.get/start
Content-Type: application/json
{ ... input fields ... }