--- title: "Get all topologies for the authenticated user's networks." method: GET path: "/api/v1/topology" tags: ["Topologies", "internal"] --- # Get all topologies for the authenticated user's networks. `GET /api/v1/topology` Returns both live-view rows (`snapshot_id IS NULL`) and snapshot-pinned rows. The frontend renders the live one by default and renders snapshot rows when the user picks one from the snapshots dropdown. ## Query parameters - `network_id` string, uuid, nullable - `ids` string[], nullable - `limit` integer, nullable - `offset` integer, nullable ## Response `200` List of topologies - PaginatedApiResponseTopology — Response type for paginated list endpoints (pagination is always present in meta) - `data` object[], required — The page of results. Empty when nothing matched the query. - `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` PaginatedApiMeta, required — API metadata for paginated list responses (pagination is always present) - `api_version` integer, required — API version (integer, increments on breaking changes) - `pagination` PaginationMeta, required — Pagination metadata returned with paginated responses. - `group_counts` GroupCount[], nullable — Size of every group, in the same order the rows are grouped, when the request specified a `group_by`. Lets a paginated client show a group's true size instead of the slice of it that happens to be on this page. Absent when the list isn't grouped. - `count` integer, required — How many rows fall in this group in total, not just on this page. - `value` string, nullable — The group's value, rendered as text. `null` for rows whose group key is NULL (the "ungrouped" bucket). - `has_more` boolean, required — Whether there are more items after this page - `limit` integer, required — Maximum items per page (as requested) - `offset` integer, required — Number of items skipped - `total_count` integer, required — Total number of items matching the filter (ignoring pagination) - `server_version` string, required — Server version (semver) - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`. ## Changes - **2026-07-29** `51af15be596e` — 2 breaking, 4 info - added `subschema #1: ByServiceCategory, subschema #2: ByTag` to the `data/items/allOf[#/components/schemas/TopologyBase]/options/request/element_rules/items/rule` response property `oneOf` list for the response status `200` - added `subschema #1: BySubnet, subschema #2: MergeContainerBridges, subschema #3: ByApplication, subschema #4: ByHost` to the `data/items/allOf[#/components/schemas/TopologyBase]/options/request/container_rules/additionalProperties/items/rule` response property `oneOf` list for the response status `200` - the `container_rules` response's property default value changed from `{"Application":[{"id":"e2d80d2a-921c-4496-9487-42a825ce0bea","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"2fdfd835-9148-46db-8659-a0175129c885","rule":"ByHost"}],"L3Logical":[{"id":"476d1d97-9824-4f6d-a309-c64255a18717","rule":"BySubnet"},{"id":"0165e666-580a-4708-a8fa-ebb9336cca4a","rule":"MergeContainerBridges"}],"Workloads":[{"id":"2fdfd835-9148-46db-8659-a0175129c885","rule":"ByHost"}]}` to `{"Application":[{"id":"e85cb8c3-4533-49f5-b6fc-07d0ac500222","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"96573351-e039-4b18-909f-9a4f316bac56","rule":"ByHost"}],"L3Logical":[{"id":"6655e907-cd09-4433-8165-6d21e4f9c057","rule":"BySubnet"},{"id":"c74f65c9-086a-4444-bd5e-42a4fee10b55","rule":"MergeContainerBridges"}],"Workloads":[{"id":"96573351-e039-4b18-909f-9a4f316bac56","rule":"ByHost"}]}` for the status `200` - the `element_rules` response's property default value changed from `{"id":"09b47623-2b40-4a9d-b700-4f1e70c89f36","rule":"ByTrunkPort"}, {"id":"b1a31f9d-f3a2-40f6-960c-4606b62bfd35","rule":"ByVLAN"}, {"id":"2d027190-f314-45da-9e01-773f5dd12625","rule":"ByPortOpStatus"}, {"id":"cdf4b65e-a765-4ab0-992d-4a927aea7f41","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"7cb2d807-033d-412c-acb3-06c2aa3f8d10","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"7ad49b15-b237-4239-816d-19658f4080a9","rule":"ByHypervisor"}, {"id":"15cc6e3c-ded9-4c56-8b9a-016bd94b4705","rule":"ByContainerRuntime"}, {"id":"359f5798-dfa1-4d43-993c-6661aa7da07b","rule":"ByStack"}` to `{"id":"29667291-c173-4e6a-bc9b-f8e65c7693fb","rule":"ByTrunkPort"}, {"id":"94dc06f7-3cd2-436c-aca4-98b23d5947d8","rule":"ByVLAN"}, {"id":"edf6cc1c-1145-4921-872c-e7a15a7be852","rule":"ByPortOpStatus"}, {"id":"1c2968fd-dd28-4065-b6f9-9e638233fc95","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"a3ed9801-78ce-4f5c-ab3f-59f5653b5e07","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"cd485c70-2737-47f3-9400-a7926ef95e64","rule":"ByHypervisor"}, {"id":"2c7cc8e7-29b4-4302-bb11-e500f9150ecb","rule":"ByContainerRuntime"}, {"id":"5e8c4746-6e7c-4904-92e1-9783c3f3fdb4","rule":"ByStack"}` for the status `200` - …2 more - …earlier changes not shown [Full history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/topology/get.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/51af15be596e/schema)