> 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/using-api-keys.md).

# Using API Keys

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

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

Expected result: current user JSON.

See [API Keys](/api/api-keys.md) for lifecycle and security details.

## Environment Variables

Store secrets outside the script:

```bash
export NETMAP_API_URL="https://netmap.example.com"
export NETMAP_API_KEY="<api-key>"
```

Then reference them:

```bash
curl --fail-with-body \
  --url "${NETMAP_API_URL}/api/v1/topology/devices" \
  --header "X-API-Key: ${NETMAP_API_KEY}"
```

## Python Example

```python
import os
import httpx

with httpx.Client(
    base_url=os.environ["NETMAP_API_URL"],
    headers={"X-API-Key": os.environ["NETMAP_API_KEY"]},
    timeout=30.0,
) as client:
    response = client.get("/api/v1/auth/me")
    response.raise_for_status()
    print(response.json())
```

## Common Mistakes

* Sending the key as a bearer token.
* Putting the key in a query string.
* Embedding the key in frontend code.
* Forgetting that proxy rules must preserve `X-API-Key`.

## Related Pages

* [API Authentication](/api/authentication.md)
* [API-Key Permissions](/api/api-key-permissions.md)
* [Rate Limits](/api/rate-limits.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/using-api-keys.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.