---
title: "PUT /api/v1/topology/{id}"
method: PUT
path: "/api/v1/topology/{id}"
tags: ["Topologies"]
---

# PUT /api/v1/topology/{id}

`PUT /api/v1/topology/{id}`

## Path parameters

- `id` string, uuid, required

## Request body

- Topology
  - `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.
            - `ByServiceCategory` object, required — One subcontainer per group of service categories.
              - …
          - object — One subcontainer per group of tags.
            - `ByTag` object, required — 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.

## Response `200`

Topology updated

- 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

---

[API](https://skmtc.net/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.net/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/versions/28e466341947/schema)