data.network.segment.update

Update a NetworkSegment (CIDRs, zone, route domain, metadata)

Apply a partial update to a NetworkSegment.

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
segment_uuid	uuid	Yes	—	UUID of the NetworkSegment to update
name	string	No	—	New display name
cidr_blocks	list	No	—	Replacement CIDR block list
availability_zone	string	No	—	AZ / zone where the segment lives
route_domain	string	No	—	Route table or domain identifier
classification	string	No	—	public/private/hybrid classification
is_public	boolean	No	—	Whether the segment is provider-public
provider_metadata	dict	No	—	Provider metadata bag
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
segment_uuid	uuid	Yes	—	UUID of the updated segment
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 segment
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 NetworkSegment (CIDRs, zone, route domain, metadata)	—
failed	FAILURE	Network workflow failed	failure_reason

API Usage

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

{
  "workflow_type": "data.network.segment.update",
  "initial_data": {
    "organization_uuid": "value",
    "segment_uuid": "value"
  }
}