Skip to content
Proud to collaborate with Microsoft for Startups

network.scope-sync ​

Synchronize detailed network inventory for one network scope

Synchronize subnets and security boundaries for one network scope.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-network
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
network_scope_uuiduuidYes—Public UUID of the NetworkScope to sync
organization_uuiduuidYes—UUID of the organization that owns the scope
workflow_run_uuidstringNo—Engine-stamped parent run UUID (DAG step target)

Output Schema ​

FieldTypeRequiredDefaultDescription
network_scope_uuiduuidNo—UUID of the synced NetworkScope (echoed)
organization_uuiduuidNo—UUID of the owning organization (echoed)
segment_countintegerNo——
security_boundary_countintegerNo——
completed_atstringNo——
failed_atstringNo——
remote_segmentsjsonNo——
remote_security_boundariesjsonNo——
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—prepare—
fetchingNoNo—reconcile—
preparingNoNo—fetch_remote_inventory—
reconcilingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedpreparepreparing—
preparingfetch_remote_inventoryfetching—
fetchingreconcilereconciling—
reconcilingcompletecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
syncedSUCCESSSynchronize detailed network inventory for one network scope—
failedFAILURENetwork workflow failedfailure_reason

API Usage ​

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

{
  "workflow_type": "network.scope-sync",
  "initial_data": {
    "network_scope_uuid": "value",
    "organization_uuid": "value"
  }
}