NotAShelf
9e5eb41d39
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I4806c58aa0a17f504c9312723ad770166a6a6964
62 lines
1.1 KiB
Markdown
Vendored
62 lines
1.1 KiB
Markdown
Vendored
# Health
|
|
|
|
Server health checks
|
|
|
|
## Endpoints
|
|
|
|
### GET /api/v1/health
|
|
|
|
Comprehensive health check - includes database, filesystem, and cache status
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | ------------- |
|
|
| 200 | Health status |
|
|
|
|
---
|
|
|
|
### GET /api/v1/health/detailed
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | ---------------------- |
|
|
| 200 | Detailed health status |
|
|
|
|
---
|
|
|
|
### GET /api/v1/health/live
|
|
|
|
Liveness probe - just checks if the server is running Returns 200 OK if the
|
|
server process is alive
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | --------------- |
|
|
| 200 | Server is alive |
|
|
|
|
---
|
|
|
|
### GET /api/v1/health/ready
|
|
|
|
Readiness probe - checks if the server can serve requests Returns 200 OK if
|
|
database is accessible
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | ---------------- |
|
|
| 200 | Server is ready |
|
|
| 503 | Server not ready |
|
|
|
|
---
|