> 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/api/endpoint-reference.md).

# Endpoint Reference

The current route inventory is maintained in [Endpoint Inventory](/api/api-reference.md). That page lists every route generated from the FastAPI app and groups them by public, authenticated, administrative, topology, discovery, monitoring, alerts, IPAM, security, tools, LLDP, and exports.

Detailed schemas are available at `/api/openapi.json` and `/api/docs`.

Documentation gap: this section still needs source-verified endpoint pages with examples for every public route.

## How To Use The Reference Today

1. Start with [API Overview](/api/api-overview.md) for base URL, authentication, errors, and rate limits.
2. Use [Endpoint Inventory](/api/api-reference.md) to find the route group.
3. Open `/api/docs` on your NetMap instance for exact schema fields.
4. Use [API Keys](/api/api-keys.md) for authentication examples.

## Endpoint Page Standard

Every endpoint page added later should include:

* method and path;
* purpose;
* authentication;
* required role or permission;
* path parameters;
* query parameters;
* request headers;
* request body;
* success response;
* implemented error responses;
* `curl` example;
* Python example where useful;
* related UI workflow;
* related endpoints.

## Priority For Expansion

Expand endpoint groups in this order:

1. API keys and authentication.
2. Devices, groups, sites, layouts, relationships.
3. Discovery and observations.
4. Monitoring and alerts.
5. IPAM.
6. Syslog/security.
7. Exports, backup, and restore.
8. Admin, OIDC, audit, and system diagnostics.
9. Tools and LLDP.

## Related Pages

* [API Authentication](/api/authentication.md)
* [Using API Keys](/api/using-api-keys.md)
* [API Errors](/api/errors.md)
* [Capability Matrix](/api/capability-matrix.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/api/endpoint-reference.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.