---
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
    - `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` 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

## Other responses

- `404` — Topology not found

## Changes

- **2026-07-23** `c037832cd07f` — 1 warning, 2 info
  - added the new `Staleness` enum value to the `data/allOf[#/components/schemas/TopologyBase]/options/request/hide_metadata_values/additionalProperties/additionalProperties/propertyNames/` response property for the response status `200`
  - the `container_rules` response's property default value changed from `{"Application":[{"id":"10b02d38-a519-4c27-a680-fe04e85a6553","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"9c4332aa-9c70-42c8-a040-2fc50417c3e2","rule":"ByHost"}],"L3Logical":[{"id":"fa2e26ab-9be1-498b-96b6-5ba76e1dc1f4","rule":"BySubnet"},{"id":"a9c04512-8e08-43aa-9c99-b3a42212c214","rule":"MergeContainerBridges"}],"Workloads":[{"id":"9c4332aa-9c70-42c8-a040-2fc50417c3e2","rule":"ByHost"}]}` to `{"Application":[{"id":"a8f37e45-b92c-44a0-a7f7-eaed64a47cf7","rule":{"ByApplication":{"tag_ids":[]}}}],"L2Physical":[{"id":"f966c31b-9cdf-4bfa-b3db-afb874cec370","rule":"ByHost"}],"L3Logical":[{"id":"6c4de0ee-a067-43bd-ac23-d4160686e69c","rule":"BySubnet"},{"id":"46fc0834-f904-4dbd-8383-dfdad740b316","rule":"MergeContainerBridges"}],"Workloads":[{"id":"f966c31b-9cdf-4bfa-b3db-afb874cec370","rule":"ByHost"}]}` for the status `200`
  - the `element_rules` response's property default value changed from `{"id":"b768e641-adf5-4d6c-bcbb-74d9b17f6452","rule":"ByTrunkPort"}, {"id":"8be65a89-95ae-4098-bf9e-d7ce91ea4b95","rule":"ByVLAN"}, {"id":"241724e8-8b1a-4512-8b7a-28a971c02b36","rule":"ByPortOpStatus"}, {"id":"74b9a6a6-c982-4a09-84cd-17116c0e4a6d","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"c726e21e-35c1-4e72-adec-f47211886d28","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"4d25d181-511a-42dd-a153-1cb69d25c1ae","rule":"ByHypervisor"}, {"id":"e211fcdd-db05-4f26-8cee-5b77d5b0dc1f","rule":"ByContainerRuntime"}, {"id":"ee9f3f19-74d9-4d8a-8b9c-7b314d5b0c75","rule":"ByStack"}` to `{"id":"41d85be3-c2f5-4e61-9179-59c20279d60c","rule":"ByTrunkPort"}, {"id":"d680ddeb-942d-4374-832e-1f36922f4633","rule":"ByVLAN"}, {"id":"09824926-7c07-441c-93c4-648aac0a3cc7","rule":"ByPortOpStatus"}, {"id":"0a4e7b12-f5a2-4c2f-a407-d2cf06c2fa40","rule":{"ByServiceCategory":{"categories":["NetworkCore","NetworkAccess","RemoteAccess","Workstation","Mobile","Printer","OpenPorts"],"is_infra_rule":true,"title":"Infrastructure"}}}, {"id":"95af47b2-2823-4aaf-953c-6dc80f1ced65","rule":{"ByTag":{"tag_ids":[],"title":null}}}, {"id":"acf506ed-08b4-4c22-aa2e-49d713114c50","rule":"ByHypervisor"}, {"id":"9ece7557-7915-4222-8671-64dc9bec059e","rule":"ByContainerRuntime"}, {"id":"b1453f48-ab53-4d95-b28e-0f501c307647","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/c037832cd07f/schema)