Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

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 whose resources should be synced

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—UUID of the connection that was synced
zones_syncedintegerNo—Number of zones written/updated
records_syncedintegerNo—Number of records written/updated
sync_completed_atstringNo—ISO-8601 timestamp of completion
truncatedbooleanNo—True when the run hit MAX_ZONES / MAX_RECORDS_PER_ZONE and stopped early
sync_skippedbooleanNo—True when sync was skipped (no plugin / non-DNS provider / etc.)
sync_reasonstringNo—Why sync was skipped, when applicable
sync_errorstringNo—Error message when sync failed mid-run
sync_failed_atstringNo—ISO-8601 timestamp of failure
failure_reasonstringNo—Engine-stamped: human-readable failure reason
failure_typestringNo—Engine-stamped: failure category
failed_actionstringNo—Engine-stamped: action method that raised
failed_at_statestringNo—Engine-stamped: state name when the failure occurred
failed_stepstringNo—Engine-stamped: name of the step that failed (DAG workflows)
failed_layerintegerNo—Engine-stamped: layer index that failed (DAG workflows)
errorstringNo—Engine-stamped: error message on the failure envelope
error_typestringNo—Engine-stamped: exception class name on the failure envelope

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeSync DNS
completedNoYesYes—Sync complete
failedNoYesNo—Sync failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

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"
  }
}