> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/using-netmap/topology.md).

# Topology

Use Topology to map devices, groups, sites, and relationships.

Common actions:

* View graph data.
* Search for a device and pan/zoom to it.
* Create or edit relationships.
* Use Path mode to highlight a path between endpoints.
* Save named layouts.
* Share layout codes and import shared layouts.
* Select multiple devices and bulk-assign group or site.

Write actions require `topology_write`.

API equivalents are under `/api/v1/topology/*`.

## What Topology Shows

Topology turns inventory records into a graph. Devices, groups, sites, and relationships are visualized so operators can understand how the network is connected.

## Common Workflows

1. Search for a device.
2. Pan and zoom the map.
3. Create or edit links.
4. Use Path mode to inspect connectivity between endpoints.
5. Save a named layout.
6. Share a layout code.
7. Bulk-select devices and assign group or site.

## Permissions

Viewing topology requires authentication. Creating or changing devices, groups, sites, or relationships requires `topology_write`.

## Troubleshooting

| Symptom                 | Likely cause                       | Fix                            |
| ----------------------- | ---------------------------------- | ------------------------------ |
| cannot edit map data    | missing `topology_write`           | update role permissions        |
| shared layout not found | revoked or mistyped code           | request a new code             |
| device missing          | inventory filter or missing record | check Inventory and graph data |

## Related Pages

* [Inventory](/using-netmap/inventory.md)
* [Share A Topology Layout](/guides/share-topology-layout.md)
* [VLANs And Groups](/using-netmap/vlans.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.netmap.dev/using-netmap/topology.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.