Skip to content
Proud to collaborate with Microsoft for Startups

data.connection.prune_dns ​

Soft-delete DNS zones/records that no longer exist on the provider

Soft-delete DnsZone/DnsRecord rows whose provider IDs are no longer listed.

Input: organization_uuid, connection_uuid, optional prune_records (default True). Output in state_data: connection_uuid, zones_pruned, records_pruned, pruned_at; or sync_skipped=True + sync_reason when preconditions are not met.

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 orphan zones/records should be pruned
prune_recordsbooleanNo—Whether to also prune orphan records inside surviving zones (default True)

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—UUID of the connection that was pruned
zones_prunedintegerNo—Number of zones soft-deleted
records_prunedintegerNo—Number of records soft-deleted
pruned_atstringNo—ISO-8601 timestamp of the prune
truncatedbooleanNo—True when the run hit MAX_ZONES / MAX_RECORDS_PER_ZONE and stopped early
sync_skippedbooleanNo—True when prune was skipped (no plugin / non-DNS provider / etc.)
sync_reasonstringNo—Why prune was skipped, when applicable
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—completePrune DNS
completedNoYesYes—Prune complete
failedNoYesNo—Prune failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

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

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