> 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/operations/health-checks.md).

# Health Checks

NetMap has two lightweight health endpoints. The all-in-one Docker image uses `/api/health` for the Docker healthcheck, and the versioned API router also exposes `/api/v1/health`.

## Endpoints

| Endpoint         | Authentication | Purpose                            |
| ---------------- | -------------- | ---------------------------------- |
| `/api/health`    | public         | container and reverse-proxy health |
| `/api/v1/health` | public         | versioned API health               |

## Manual Check

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

Expected:

```json
{"status":"ok"}
```

## Docker Check

```bash
docker compose ps
```

The Dockerfile healthcheck calls:

```bash
python3 -c "import urllib.request; urllib.request.urlopen('http://127.0.0.1:${APP_PORT}/api/health', timeout=5)"
```

## External Monitoring

Point external uptime monitors at the public HTTPS URL:

```
https://netmap.example.com/api/health
```

Use a short timeout. The endpoint is public and does not require an API key.

## What Health Does Not Prove

A passing health check confirms the web/API process is responding. It does not prove:

* syslog senders are connected;
* scheduled discovery is running correctly;
* notification delivery succeeds;
* database backups are fresh;
* every worker is healthy.

Use Admin diagnostics and logs for deeper checks.

## Related Pages

* [Monitoring NetMap](/operations/monitoring-netmap.md)
* [Logging](/operations/logging.md)
* [Installation Problems](/troubleshooting/installation-problems.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/operations/health-checks.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.