--- title: "Get all topologies for the authenticated user's networks." method: GET path: "/api/v1/topology" tags: ["Topologies"] --- # 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-08-25** `b4189fccca72` — 2 info - the `container_rules` response's property default value changed from `{"Application":[{"id":"3b10e2e3-054c-403b-af4a-6322942754d0","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"87cc9a7d-a263-4c9b-89d3-e66b96bb8569","rule":"ByHost"}],"L3Logical":[{"id":"282f9ae4-79ad-4642-abeb-95183b4e90be","rule":"BySubnet"},{"id":"329551de-fd2e-4dcc-98db-d35f343f1fb1","rule":"MergeContainerBridges"}],"Workloads":[{"id":"87cc9a7d-a263-4c9b-89d3-e66b96bb8569","rule":"ByHost"}]}` to `{"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"}]}` for the status `200` - the `element_rules` response's property default value changed from `{"id":"73aaadcf-2b1a-42e8-9f90-4a58968e3dda","rule":"ByTrunkPort"}, {"id":"134bf26c-33e4-4620-81c0-864d767284fe","rule":"ByVLAN"}, {"id":"b57181b5-941f-499d-a975-e2345e2e3b05","rule":"ByPortOpStatus"}, {"id":"cce27a35-11b2-4f9b-8eb8-5203e861c4f7","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"3720a046-9112-4694-8541-c9a67fef19d2","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"0c512b2e-3e03-4c0a-b2ae-b7043b847243","rule":"ByHypervisor"}, {"id":"2e1a1c48-7da7-4e05-a9be-f939515b72ec","rule":"ByContainerRuntime"}, {"id":"17425e24-f87d-4a2e-aa82-c9f5ac051c37","rule":"ByStack"}` to `{"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"}` for the status `200` - …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/b4189fccca72/schema)