--- 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 - `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` 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 ## Changes - **2026-07-29** `49ea97c8bb7e` — 3 info - added the optional property `meta/pagination/group_counts` to the response with the `200` status - the `container_rules` response's property default value changed from `{"Application":[{"id":"e2463610-3f5f-48bf-a496-566b45805a54","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"6d5aa66e-4858-4fe6-9d35-fa669b670b5b","rule":"ByHost"}],"L3Logical":[{"id":"05f7cd5f-d8f1-4f0d-b8c8-dcd3ae50f60a","rule":"BySubnet"},{"id":"23bab0bf-e92e-407f-a1a5-5629297047d8","rule":"MergeContainerBridges"}],"Workloads":[{"id":"6d5aa66e-4858-4fe6-9d35-fa669b670b5b","rule":"ByHost"}]}` to `{"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"}]}` for the status `200` - the `element_rules` response's property default value changed from `{"id":"494fb957-5348-494e-b87d-80aabfa7673f","rule":"ByTrunkPort"}, {"id":"a04e42e4-c5c9-4197-82cd-8871c6a78e70","rule":"ByVLAN"}, {"id":"2541e06c-88e5-4c03-85a3-3492d2690267","rule":"ByPortOpStatus"}, {"id":"90498ff6-5e05-4b1f-9f76-2e45a7daebc9","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"6abe836a-007c-47b4-a51b-bf7375b4b375","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"2a384aff-b517-4989-95e4-80936f4350f4","rule":"ByHypervisor"}, {"id":"262d47a7-b9f1-4336-b8d1-5592999b5071","rule":"ByContainerRuntime"}, {"id":"a456af2e-f804-4840-ac44-d690ff9536c3","rule":"ByStack"}` to `{"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"}` 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/49ea97c8bb7e/schema)