data.connection.sync_dns ​
Sync DNS zones and records from provider to DB
Sync DNS zones and records for a connection.
Input: organization_uuid, connection_uuid. Output: connection_uuid, zones_synced, records_synced, sync_completed_at; or sync_skipped=True + sync_reason; or sync_error + sync_failed_at.
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 whose resources should be synced |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | UUID of the connection that was synced |
zones_synced | integer | No | — | Number of zones written/updated |
records_synced | integer | No | — | Number of records written/updated |
sync_completed_at | string | No | — | ISO-8601 timestamp of completion |
truncated | boolean | No | — | True when the run hit MAX_ZONES / MAX_RECORDS_PER_ZONE and stopped early |
sync_skipped | boolean | No | — | True when sync was skipped (no plugin / non-DNS provider / etc.) |
sync_reason | string | No | — | Why sync was skipped, when applicable |
sync_error | string | No | — | Error message when sync failed mid-run |
sync_failed_at | string | No | — | ISO-8601 timestamp of failure |
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 | Sync DNS |
completed | No | Yes | Yes | — | Sync complete |
failed | No | Yes | No | — | Sync 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.sync_dns",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value"
}
}