network.topology.discover

Build a local topology snapshot from synced network inventory

Build a local topology snapshot from synced network inventory.

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
provider	string	No	—	Optional provider filter such as aws, gcp, or cloudflare
backend_type	string	No	—	Optional NetworkBackendType filter such as aws_vpc or gcp_vpc
network_account_uuid	uuid	No	—	Optional NetworkAccount UUID filter
include_profiles	boolean	No	—	Include NetworkProfile summaries; default true
include_segments	boolean	No	—	Include segment summaries; default true
include_security_boundaries	boolean	No	—	Include security boundary summaries; default true
include_deleted	boolean	No	—	Include soft-deleted inventory; default false
limit	integer	No	—	Max accounts to return; default 100, capped at 500
offset	integer	No	—	Pagination offset for accounts
actor	string	No	—	Caller initiating topology discovery

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
domains	list	Yes	—	—
domain_count	integer	Yes	—	—
scope_count	integer	Yes	—	—
segment_count	integer	Yes	—	—
security_boundary_count	integer	Yes	—	—
profile_count	integer	Yes	—	—
providers_present	list	Yes	—	—
graph	dict	Yes	—	—
cidr_overlaps	list	Yes	—	—
invalid_cidrs	list	Yes	—	—
unsupported_capabilities	list	Yes	—	—
warnings	list	Yes	—	—
limit	integer	Yes	—	—
offset	integer	Yes	—	—
discovered_at	string	Yes	—	—
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
done	Yes	Yes	Yes	—	—

Outcomes

Outcome	Type	Description	State Data Keys
discovered	SUCCESS	Build a local topology snapshot from synced network inventory	domain_count, scope_count
failed	FAILURE	Network workflow failed	failure_reason

API Usage

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

{
  "workflow_type": "network.topology.discover",
  "initial_data": {
    "organization_uuid": "value"
  }
}