--- title: "PUT /api/v1/topology/{id}" method: PUT path: "/api/v1/topology/{id}" tags: ["Topologies", "internal"] --- # PUT /api/v1/topology/{id} `PUT /api/v1/topology/{id}` ## Path parameters - `id` string, uuid, required ## Request body - Topology - `network_id` string, uuid, required - `options` TopologyOptions, required - `local` TopologyLocalOptions, required - `bundle_edges` boolean - `hide_edge_types` EdgeTypeDiscriminants[] - `no_fade_edges` boolean - `show_minimap` boolean - `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 - `element_rules` IdentifiedRuleElementRule[] - `id` string, uuid, required - `rule` union, required — Rules that organize nodes within a container into sub-groups. - object - `ByServiceCategory` object, required - … - object - `ByTag` object, required - … - '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 - `id` string, uuid, required - `updated_at` string, date-time, required ## Response `200` Topology updated - ApiResponseTopology - `data` object - `network_id` string, uuid, required - `options` TopologyOptions, required - `local` TopologyLocalOptions, required - `bundle_edges` boolean - `hide_edge_types` EdgeTypeDiscriminants[] - `no_fade_edges` boolean - `show_minimap` boolean - `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 - `element_rules` IdentifiedRuleElementRule[] - `id` string, uuid, required - `rule` union, required — Rules that organize nodes within a container into sub-groups. - object - … - object - … - '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 - `id` string, uuid, required - `updated_at` string, date-time, required - `error` string, nullable - `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 ## Other responses - `404` — Topology not found ## Changes - **2026-07-22** `9a909a590f9c` — 1 warning, 5 info - added the new `SameContainer` enum value to the `data/allOf[#/components/schemas/TopologyBase]/options/local/hide_edge_types/items/` response property for the response status `200` - the `container_rules` request property default value changed from `{"Application":[{"id":"f6a64970-26dc-49ad-96c8-7763be711801","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"8db5ea75-ab4c-4a80-95ab-5a5876db5e97","rule":"ByHost"}],"L3Logical":[{"id":"4ad63ccd-9c94-4bea-97e5-b18d6d9b5f7d","rule":"BySubnet"},{"id":"669fb76d-0ed0-419c-8b67-d8417965a855","rule":"MergeContainerBridges"}],"Workloads":[{"id":"8db5ea75-ab4c-4a80-95ab-5a5876db5e97","rule":"ByHost"}]}` to `{"Application":[{"id":"10b02d38-a519-4c27-a680-fe04e85a6553","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"9c4332aa-9c70-42c8-a040-2fc50417c3e2","rule":"ByHost"}],"L3Logical":[{"id":"fa2e26ab-9be1-498b-96b6-5ba76e1dc1f4","rule":"BySubnet"},{"id":"a9c04512-8e08-43aa-9c99-b3a42212c214","rule":"MergeContainerBridges"}],"Workloads":[{"id":"9c4332aa-9c70-42c8-a040-2fc50417c3e2","rule":"ByHost"}]}` - the `element_rules` request property default value changed from `{"id":"b61f1d54-78d9-4a42-99bf-9ebd3d132a81","rule":"ByTrunkPort"}, {"id":"fdaaa9b7-2a7c-46b5-97fb-6a72013b9e3e","rule":"ByVLAN"}, {"id":"b4f5d679-162f-45ed-94a1-de810d9ef51a","rule":"ByPortOpStatus"}, {"id":"11c27240-0383-49d1-9ec9-8f04ed2ec813","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"d96da2e3-8226-46d7-aff2-deb9b71f31dd","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"6377cfeb-2d75-4349-a87c-26e12717302c","rule":"ByHypervisor"}, {"id":"4b025a32-75bd-4f8f-a389-25f2fc8a5be0","rule":"ByContainerRuntime"}, {"id":"bd688fed-55e5-42de-b362-cecec621b964","rule":"ByStack"}` to `{"id":"b768e641-adf5-4d6c-bcbb-74d9b17f6452","rule":"ByTrunkPort"}, {"id":"8be65a89-95ae-4098-bf9e-d7ce91ea4b95","rule":"ByVLAN"}, {"id":"241724e8-8b1a-4512-8b7a-28a971c02b36","rule":"ByPortOpStatus"}, {"id":"74b9a6a6-c982-4a09-84cd-17116c0e4a6d","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"c726e21e-35c1-4e72-adec-f47211886d28","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"4d25d181-511a-42dd-a153-1cb69d25c1ae","rule":"ByHypervisor"}, {"id":"e211fcdd-db05-4f26-8cee-5b77d5b0dc1f","rule":"ByContainerRuntime"}, {"id":"ee9f3f19-74d9-4d8a-8b9c-7b314d5b0c75","rule":"ByStack"}` - added the new `SameContainer` enum value to the request property `allOf[#/components/schemas/TopologyBase]/options/local/hide_edge_types/items/` - …2 more - …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/bd76f90aa44b/schema)