> 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/troubleshooting/diagnostic-information.md).

# Diagnostic Information

Collect:

* NetMap version from `GET /api/v1/system/version`.
* Health endpoint result.
* Container logs.
* Compose configuration with secrets redacted.
* Admin diagnostics output with private data reviewed.
* Exact API endpoint, status code, and `detail` body for API failures.

Do not include API keys, passwords, tokens, private keys, or screenshots showing secrets.

## Commands

```bash
curl --fail http://127.0.0.1:8080/api/health
docker compose ps
docker compose logs --tail=200 netmap
```

Version check:

```bash
curl --fail http://127.0.0.1:8080/api/v1/system/version
```

SuperAdmin diagnostics through the API:

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

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

## Redaction Checklist

Remove:

* API keys;
* JWTs;
* refresh tokens;
* passwords;
* OIDC secrets;
* notification webhook URLs;
* private keys;
* sensitive public IPs or hostnames.

## Related Pages

* [Logging](/operations/logging.md)
* [Common Issues](/troubleshooting/common-issues.md)
* [Security Model](/security/security-model.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/troubleshooting/diagnostic-information.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.