--- title: "PUT /api/v1/topology/{id}" method: PUT path: "/api/v1/topology/{id}" tags: ["Topologies"] --- # PUT /api/v1/topology/{id} `PUT /api/v1/topology/{id}` ## Path parameters - `id` string, uuid, required ## Request body - Topology - `network_id` string, uuid, required — The network this entity belongs to. - `options` TopologyOptions, required - `local` TopologyLocalOptions, required - `bundle_edges` boolean — Collapse parallel edges between the same pair of nodes into one. - `hide_edge_types` EdgeTypeDiscriminants[] — Edge types to leave out of the drawing. - `no_fade_edges` boolean — Keep unrelated edges at full opacity when something is selected. - `show_minimap` boolean — Show the minimap. - `tag_filter` TopologyTagFilter — Filter settings for hiding entities by tag in topology visualization. - `hidden_host_tag_ids` string[] — Host tag IDs to hide (hosts with these tags will fade out) - `hidden_service_tag_ids` string[] — Service tag IDs to hide (services with these tags will be hidden from nodes) - `hidden_subnet_tag_ids` string[] — Subnet tag IDs to hide (subnets with these tags will fade out) - `request` TopologyRequestOptions, required - `container_rules` object — Rules deciding how nodes are grouped into containers. - `element_rules` IdentifiedRuleElementRule[] — Rules deciding how entities are placed and inlined within containers. - `id` string, uuid, required — Server-assigned unique identifier. - `rule` union, required — Rules that organize nodes within a container into sub-groups. - object — One subcontainer per group of service categories. - `ByServiceCategory` object, required — One subcontainer per group of service categories. - … - object — One subcontainer per group of tags. - `ByTag` object, required — One subcontainer per group of tags. - … - 'ByHypervisor' - 'ByContainerRuntime' - 'ByStack' - 'ByTrunkPort' — Groups trunk ports (ports with tagged VLANs) into a "Trunk Ports" subcontainer. Higher priority than ByVLAN — prevents trunk ports from being grouped by VLAN. - 'ByVLAN' — Groups access ports by their native VLAN ID into per-VLAN subcontainers. - 'ByPortOpStatus' — Groups ports by operational status (Up, Down, etc.) into per-status subcontainers. - `hide_entities` object — Entity types hidden per view. Keyed by TopologyView, values are entity types (matching those declared as container/element/inline in the view's element_config). Hides every manifestation of the entity in that view — element nodes, container nodes, and inline rows on element cards. Supersedes the old `hide_ports` (L3-only, inline-only). - `hide_metadata_values` object — Generic per-(view, entity, filter) hide-set for metadata filters (Category, Virtualization, etc). Supersedes the old `hide_service_categories`; nested so JSON keys are strings all the way down. - `created_at` string, date-time, required — When this record was first created. - `id` string, uuid, required — Server-assigned unique identifier. - `updated_at` string, date-time, required — When this record was last modified. ## Response `200` Topology updated - ApiResponseTopology - `data` object — The result payload. Omitted on failure. - `network_id` string, uuid, required — The network this entity belongs to. - `options` TopologyOptions, required - `local` TopologyLocalOptions, required - `bundle_edges` boolean — Collapse parallel edges between the same pair of nodes into one. - `hide_edge_types` EdgeTypeDiscriminants[] — Edge types to leave out of the drawing. - `no_fade_edges` boolean — Keep unrelated edges at full opacity when something is selected. - `show_minimap` boolean — Show the minimap. - `tag_filter` TopologyTagFilter — Filter settings for hiding entities by tag in topology visualization. - `hidden_host_tag_ids` string[] — Host tag IDs to hide (hosts with these tags will fade out) - `hidden_service_tag_ids` string[] — Service tag IDs to hide (services with these tags will be hidden from nodes) - `hidden_subnet_tag_ids` string[] — Subnet tag IDs to hide (subnets with these tags will fade out) - `request` TopologyRequestOptions, required - `container_rules` object — Rules deciding how nodes are grouped into containers. - `element_rules` IdentifiedRuleElementRule[] — Rules deciding how entities are placed and inlined within containers. - `id` string, uuid, required — Server-assigned unique identifier. - `rule` union, required — Rules that organize nodes within a container into sub-groups. - object — One subcontainer per group of service categories. - … - object — One subcontainer per group of tags. - … - 'ByHypervisor' - 'ByContainerRuntime' - 'ByStack' - 'ByTrunkPort' — Groups trunk ports (ports with tagged VLANs) into a "Trunk Ports" subcontainer. Higher priority than ByVLAN — prevents trunk ports from being grouped by VLAN. - 'ByVLAN' — Groups access ports by their native VLAN ID into per-VLAN subcontainers. - 'ByPortOpStatus' — Groups ports by operational status (Up, Down, etc.) into per-status subcontainers. - `hide_entities` object — Entity types hidden per view. Keyed by TopologyView, values are entity types (matching those declared as container/element/inline in the view's element_config). Hides every manifestation of the entity in that view — element nodes, container nodes, and inline rows on element cards. Supersedes the old `hide_ports` (L3-only, inline-only). - `hide_metadata_values` object — Generic per-(view, entity, filter) hide-set for metadata filters (Category, Virtualization, etc). Supersedes the old `hide_service_categories`; nested so JSON keys are strings all the way down. - `created_at` string, date-time, required — When this record was first created. - `id` string, uuid, required — Server-assigned unique identifier. - `updated_at` string, date-time, required — When this record was last modified. - `error` string, nullable — Human-readable failure message. Omitted on success. - `meta` ApiMeta, required — API metadata included in all responses - `api_version` integer, required — API version (integer, increments on breaking changes) - `server_version` string, required — Server version (semver) - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`. ## Other responses - `404` — Topology not found ## Changes - **2026-08-25** `b1cea2733fef` — 4 info - the `container_rules` request property default value changed from `{"Application":[{"id":"6a4b748d-bdd7-4df5-9a12-76c97f1517df","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"b247842f-02d5-479f-ad97-6e46fe411d31","rule":"ByHost"}],"L3Logical":[{"id":"e74084c5-5dc0-4cab-9947-2d816a290922","rule":"BySubnet"},{"id":"8cad1720-76c4-429f-b85e-0524e1508224","rule":"MergeContainerBridges"}],"Workloads":[{"id":"b247842f-02d5-479f-ad97-6e46fe411d31","rule":"ByHost"}]}` to `{"Application":[{"id":"ed91b0a7-a4aa-4d13-ac46-7391a1ee671f","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"41f1b5e0-b0ca-428a-9678-00dab0be9101","rule":"ByHost"}],"L3Logical":[{"id":"fdb43ba1-1ab9-43ae-abc5-893485681291","rule":"BySubnet"},{"id":"ec52c714-75f5-4780-9003-3ec8bfe99637","rule":"MergeContainerBridges"}],"Workloads":[{"id":"41f1b5e0-b0ca-428a-9678-00dab0be9101","rule":"ByHost"}]}` - the `element_rules` request property default value changed from `{"id":"3cfc4105-2f24-4b94-8727-6dcb2117e1cc","rule":"ByTrunkPort"}, {"id":"f8d15480-7d52-4715-8d78-f1269f2e469c","rule":"ByVLAN"}, {"id":"3aada207-5f33-489b-82ba-c58e1a6fff43","rule":"ByPortOpStatus"}, {"id":"c541b65a-2342-4cfd-9903-378dd7e9e585","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"33dd2396-3ad0-41c8-a953-237713940a31","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"b39c15ef-0983-4a0e-bddd-278aad8e7c0c","rule":"ByHypervisor"}, {"id":"67c761b7-f0a4-49b6-8577-cf0c1cf5b2e1","rule":"ByContainerRuntime"}, {"id":"bf17a683-ac9f-45fc-9c40-b0453a2d2c30","rule":"ByStack"}` to `{"id":"9813531e-b5ef-4067-bf63-687a6496913f","rule":"ByTrunkPort"}, {"id":"db481467-a1d3-4496-b159-d4c08345ac91","rule":"ByVLAN"}, {"id":"e25e521b-0cfc-476b-91f8-c755cc010f69","rule":"ByPortOpStatus"}, {"id":"a35605ab-d9e1-439b-8e18-06c350dbfeee","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"07342dd6-9bbb-4fe6-9889-23746abb6c5d","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"6adc6471-c148-4a48-aa19-ebd951421ba7","rule":"ByHypervisor"}, {"id":"2f28b9f4-49d6-40cb-9745-5a45f1f0ace0","rule":"ByContainerRuntime"}, {"id":"53e9f36d-50e5-487f-a976-8228e8399341","rule":"ByStack"}` - the `container_rules` response's property default value changed from `{"Application":[{"id":"6a4b748d-bdd7-4df5-9a12-76c97f1517df","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"b247842f-02d5-479f-ad97-6e46fe411d31","rule":"ByHost"}],"L3Logical":[{"id":"e74084c5-5dc0-4cab-9947-2d816a290922","rule":"BySubnet"},{"id":"8cad1720-76c4-429f-b85e-0524e1508224","rule":"MergeContainerBridges"}],"Workloads":[{"id":"b247842f-02d5-479f-ad97-6e46fe411d31","rule":"ByHost"}]}` to `{"Application":[{"id":"ed91b0a7-a4aa-4d13-ac46-7391a1ee671f","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"41f1b5e0-b0ca-428a-9678-00dab0be9101","rule":"ByHost"}],"L3Logical":[{"id":"fdb43ba1-1ab9-43ae-abc5-893485681291","rule":"BySubnet"},{"id":"ec52c714-75f5-4780-9003-3ec8bfe99637","rule":"MergeContainerBridges"}],"Workloads":[{"id":"41f1b5e0-b0ca-428a-9678-00dab0be9101","rule":"ByHost"}]}` for the status `200` - the `element_rules` response's property default value changed from `{"id":"3cfc4105-2f24-4b94-8727-6dcb2117e1cc","rule":"ByTrunkPort"}, {"id":"f8d15480-7d52-4715-8d78-f1269f2e469c","rule":"ByVLAN"}, {"id":"3aada207-5f33-489b-82ba-c58e1a6fff43","rule":"ByPortOpStatus"}, {"id":"c541b65a-2342-4cfd-9903-378dd7e9e585","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"33dd2396-3ad0-41c8-a953-237713940a31","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"b39c15ef-0983-4a0e-bddd-278aad8e7c0c","rule":"ByHypervisor"}, {"id":"67c761b7-f0a4-49b6-8577-cf0c1cf5b2e1","rule":"ByContainerRuntime"}, {"id":"bf17a683-ac9f-45fc-9c40-b0453a2d2c30","rule":"ByStack"}` to `{"id":"9813531e-b5ef-4067-bf63-687a6496913f","rule":"ByTrunkPort"}, {"id":"db481467-a1d3-4496-b159-d4c08345ac91","rule":"ByVLAN"}, {"id":"e25e521b-0cfc-476b-91f8-c755cc010f69","rule":"ByPortOpStatus"}, {"id":"a35605ab-d9e1-439b-8e18-06c350dbfeee","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"07342dd6-9bbb-4fe6-9889-23746abb6c5d","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"6adc6471-c148-4a48-aa19-ebd951421ba7","rule":"ByHypervisor"}, {"id":"2f28b9f4-49d6-40cb-9745-5a45f1f0ace0","rule":"ByContainerRuntime"}, {"id":"53e9f36d-50e5-487f-a976-8228e8399341","rule":"ByStack"}` for the status `200` - …earlier changes not shown [Full history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/topology/:id/put.md) --- [API](https://skmtc.dev/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.dev/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/b1cea2733fef/schema)