> 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/inventory.md).

# Inventory

Use Inventory to search, filter, create, update, delete, favourite, and import devices.

API equivalents:

* `GET /api/v1/topology/devices`
* `POST /api/v1/topology/devices`
* `PATCH /api/v1/topology/devices/{device_id}`
* `DELETE /api/v1/topology/devices/{device_id}`
* `POST /api/v1/topology/devices/import`

Write actions require `topology_write`.

## Who Can Access It

Any authenticated user can view inventory. Create, update, delete, import, and bulk-edit actions require `topology_write`.

## What Inventory Is For

Inventory is the tabular source of device records. Use it when you need to:

* find a device by name, hostname, IP, type, group, or site;
* correct device metadata;
* add devices before drawing topology links;
* import discovered or CSV data;
* mark important devices as favourites;
* open device details.

## Typical Workflow

1. Open Inventory.
2. Search or filter the device list.
3. Select a device to inspect details.
4. Edit fields when metadata is stale.
5. Use import for bulk onboarding.
6. Move to Topology when relationships or layout need attention.

## Example: List Devices

```bash
API_URL="https://netmap.example.com"
API_KEY="<api-key>"

curl --fail-with-body \
  --url "${API_URL}/api/v1/topology/devices" \
  --header "X-API-Key: ${API_KEY}" \
  --header "Accept: application/json"
```

## Common Problems

| Symptom                      | Likely cause                                 | Fix                                         |
| ---------------------------- | -------------------------------------------- | ------------------------------------------- |
| cannot save edits            | missing `topology_write`                     | ask a SuperAdmin to adjust role permissions |
| duplicate-looking devices    | discovery/import created separate records    | merge manually or correct import data       |
| device missing from topology | hidden group/filter or missing graph refresh | check topology filters and reload           |

## Related Pages

* [Add A Device](/guides/add-device.md)
* [Import Devices](/guides/import-devices.md)
* [Topology](/using-netmap/topology.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/inventory.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.