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

# IPAM

IPAM manages subnets, address grids, reservations, DHCP lease imports, and conflicts.

API equivalents:

* `/api/v1/ipam/summary`
* `/api/v1/ipam/subnets`
* `/api/v1/ipam/reservations`
* `/api/v1/ipam/dhcp-leases`
* `/api/v1/ipam/conflicts`
* `/api/v1/ipam/vlan-suggestions`

Write actions require `ipam_write`.

## What IPAM Helps With

Use IPAM to understand how address space is used and where conflicts exist. It combines known device IPs, DHCP lease data, and reservation records.

Common tasks:

* create and edit subnets;
* inspect address grids;
* find next available addresses;
* reserve IPs;
* import DHCP leases;
* clear expired reservations;
* review conflicts;
* import subnet suggestions from VLAN groups.

## API Example

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

curl --fail-with-body \
  --url "${API_URL}/api/v1/ipam/summary" \
  --header "X-API-Key: ${API_KEY}"
```

## Common Problems

| Symptom                      | Likely cause                       | Fix                           |
| ---------------------------- | ---------------------------------- | ----------------------------- |
| cannot create subnet         | missing `ipam_write`               | update role permissions       |
| address count seems wrong    | stale device/DHCP/reservation data | refresh relevant data sources |
| import from VLAN unavailable | no valid VLAN group suggestions    | check group IP range metadata |

## Related Pages

* [Create An IP Reservation](/guides/create-ip-reservation.md)
* [Import DHCP Leases](/guides/import-dhcp-leases.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/ipam.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.