littlelink-server/docs/healthcheck.md
Kieran a425aec9ff
Update Read Me (#150)
* Added Ghost to Docker-Compose

* Updated Readme

* Rm extra dividers

* Updated description

* Added screenshot

* Added Config Heading

* RM configuration

* Added missing links

* Added configuration

* Added emoji

* Rm docs reference

* Small typo

* Updated manylink

* RM littlelink logo

* Updated URL

* Changed fork of to Inspired by

* Linting

* Linting

* Added link emoji for h1
2022-06-22 09:44:08 -05:00

15 lines
289 B
Markdown

## 🩺 Health Check
A health check endpoint exists on `/healthcheck`. If healthy, it will return with a `200` and the following response:
```json
{
"status": "ok"
}
```
To skip express from logging these calls, add the environment variable:
```bash
SKIP_HEALTH_CHECK_LOGS=true
```