data.network.scope.update ​
Update a NetworkScope (name, CIDRs, status, metadata)
Apply a partial update to a NetworkScope.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-network |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | UUID of the organization |
network_scope_uuid | uuid | Yes | — | UUID of the NetworkScope to update |
name | string | No | — | New display name |
cidr_blocks | list | No | — | Replacement CIDR block list |
is_default | boolean | No | — | Whether this is the provider default scope |
provider_metadata | dict | No | — | Provider metadata bag |
cached_sync_status | string | No | — | NetworkSyncStatus value (pending |
last_sync_error | string | No | — | Error string recorded by sync; clear with empty string |
active_workflow_uuid | string | No | — | Workflow uuid currently driving the scope; clear by passing empty string |
touch_last_synced_at | boolean | No | — | When True, set last_synced_at to now |
actor | string | No | — | Caller initiating the update |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
network_scope_uuid | uuid | Yes | — | UUID of the updated scope |
updated_fields | list | Yes | — | Names of fields that were applied |
updated_at | string | Yes | — | ISO-8601 timestamp of the update |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped step name (DAG path) |
failed_layer | integer | No | — | Engine-stamped layer index (DAG path) |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Update scope |
completed | No | Yes | Yes | — | Updated |
failed | No | Yes | No | — | Update failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
updated | SUCCESS | Update a NetworkScope (name, CIDRs, status, metadata) | — |
failed | FAILURE | Network workflow failed | failure_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"
}
}