---
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-08-16** `ce3ad60b9b03` — 2 info
  - the `container_rules` response's property default value changed from `{"Application":[{"id":"180672b9-b35d-4598-a288-e60f7a6c0bb6","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"b64c474e-f198-4274-9a8f-641078efda12","rule":"ByHost"}],"L3Logical":[{"id":"e02fc909-1d01-4012-9a8d-942361af6269","rule":"BySubnet"},{"id":"c5736769-dee7-449b-90b2-ca47d8b0cb2e","rule":"MergeContainerBridges"}],"Workloads":[{"id":"b64c474e-f198-4274-9a8f-641078efda12","rule":"ByHost"}]}` to `{"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"}]}` for the status `200`
  - the `element_rules` response's property default value changed from `{"id":"20ea9d27-3e75-4e05-9a5b-ad8138c3e503","rule":"ByTrunkPort"}, {"id":"02b791d1-4c86-4403-9b7b-a50a43cf46e1","rule":"ByVLAN"}, {"id":"14b2ffb2-1b77-40a8-ab82-ecbb4863bb37","rule":"ByPortOpStatus"}, {"id":"341ca820-5732-442f-89bb-f2bfa4fc7f1f","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"103708eb-ecb4-4b05-8e93-58471de62737","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"e1b2b0b8-1a3d-41c8-9112-86f2388b3063","rule":"ByHypervisor"}, {"id":"d0f094d6-da4e-4cc8-a329-2f690d5fbdde","rule":"ByContainerRuntime"}, {"id":"14a50d63-2c63-4ff2-9ff4-320bd8a969ed","rule":"ByStack"}` to `{"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"}` 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/2df1fc47dfa7/schema)