Skip to content
Proud to collaborate with Microsoft for Startups

data.network.scope.update ​

Update a NetworkScope (name, CIDRs, status, metadata)

Apply a partial update to a NetworkScope.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-network
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization
network_scope_uuiduuidYes—UUID of the NetworkScope to update
namestringNo—New display name
cidr_blockslistNo—Replacement CIDR block list
is_defaultbooleanNo—Whether this is the provider default scope
provider_metadatadictNo—Provider metadata bag
cached_sync_statusstringNo—NetworkSyncStatus value (pending
last_sync_errorstringNo—Error string recorded by sync; clear with empty string
active_workflow_uuidstringNo—Workflow uuid currently driving the scope; clear by passing empty string
touch_last_synced_atbooleanNo—When True, set last_synced_at to now
actorstringNo—Caller initiating the update

Output Schema ​

FieldTypeRequiredDefaultDescription
network_scope_uuiduuidYes—UUID of the updated scope
updated_fieldslistYes—Names of fields that were applied
updated_atstringYes—ISO-8601 timestamp of the update
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
pendingYesNo—completeUpdate scope
completedNoYesYes—Updated
failedNoYesNo—Update failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
updatedSUCCESSUpdate a NetworkScope (name, CIDRs, status, metadata)—
failedFAILURENetwork workflow failedfailure_reason

API Usage ​

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

{
  "workflow_type": "data.network.scope.update",
  "initial_data": {
    "organization_uuid": "value",
    "network_scope_uuid": "value"
  }
}