--- title: "Get Topology by ID" method: GET path: "/api/v1/topology/{id}" tags: ["Topologies"] --- # Get Topology by ID `GET /api/v1/topology/{id}` ## Path parameters - `id` string, uuid, required ## Response `200` Topology found - 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-07-29** `083ffc16aae1` — 2 info - the `container_rules` response's property default value changed from `{"Application":[{"id":"35e7e29a-baec-4f76-8eae-ea8fa1f73b20","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"a7ff785b-eaaa-405a-bd60-94b396956b36","rule":"ByHost"}],"L3Logical":[{"id":"fb96418b-009a-4a9a-b09c-7f151e1bd985","rule":"BySubnet"},{"id":"81a4750e-dc3a-4d1d-a1a7-fe32e7b7b06c","rule":"MergeContainerBridges"}],"Workloads":[{"id":"a7ff785b-eaaa-405a-bd60-94b396956b36","rule":"ByHost"}]}` to `{"Application":[{"id":"398d0287-bc2d-4753-99bc-b5ac170172b5","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"385a9401-906a-4f8e-8f4f-c02564e8d173","rule":"ByHost"}],"L3Logical":[{"id":"3b5aa500-b9cb-4f5f-a94a-52412a1815b0","rule":"BySubnet"},{"id":"32477e07-d47c-44a6-90a7-f7666f5408e4","rule":"MergeContainerBridges"}],"Workloads":[{"id":"385a9401-906a-4f8e-8f4f-c02564e8d173","rule":"ByHost"}]}` for the status `200` - the `element_rules` response's property default value changed from `{"id":"5db6187b-e9b1-4e74-8d08-383009530b4b","rule":"ByTrunkPort"}, {"id":"d9f59e50-b89b-4a9f-8eb9-aa0b162bd194","rule":"ByVLAN"}, {"id":"f5b6251a-079d-454c-aaad-6a4df680ce05","rule":"ByPortOpStatus"}, {"id":"d26ab6b1-abea-47b0-9005-b96b50b4d306","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"2e43f331-7e4b-49de-bf19-b71ffc0df4c0","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"b0ce7d24-b41d-4842-baf4-c596d5d74c98","rule":"ByHypervisor"}, {"id":"683d48b1-1a38-4252-be0f-2558ceb8d573","rule":"ByContainerRuntime"}, {"id":"ab761a9d-602e-4f3c-b073-e9b8ac736fd4","rule":"ByStack"}` to `{"id":"b639a20c-3d84-4365-871f-4bf152ddd0a8","rule":"ByTrunkPort"}, {"id":"300857a5-6b64-4926-853f-86e4f0bc97ac","rule":"ByVLAN"}, {"id":"f3cb5129-6282-4814-b8ab-e440af777788","rule":"ByPortOpStatus"}, {"id":"d2e85250-eb06-40e3-b8e8-f231ade2bead","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"4f4a8d39-d504-45ef-9d31-f6db1755d122","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"59b8b695-b1c5-485e-b32c-41edb0129dc7","rule":"ByHypervisor"}, {"id":"6e0c3d69-dc0a-40e9-ada6-47a53506d054","rule":"ByContainerRuntime"}, {"id":"645619b3-5092-49b1-b073-cc583e8b9790","rule":"ByStack"}` for the status `200` - …earlier changes not shown [Full history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/topology/:id/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/083ffc16aae1/schema)