diff options
| author | kaniini <nenolod@gmail.com> | 2019-04-22 07:19:53 +0000 |
|---|---|---|
| committer | kaniini <nenolod@gmail.com> | 2019-04-22 07:19:53 +0000 |
| commit | 05862ded7a156ad6db16a70ec90045a2149da97d (patch) | |
| tree | 3f87cabddf373b61a33b901fe4084414e21f2977 /docs | |
| parent | 7fcbda702e76b6390076c28832f5aea80086d15a (diff) | |
| parent | 88f0be96933c287b99469edcfb6483cc91fa73c8 (diff) | |
| download | pleroma-05862ded7a156ad6db16a70ec90045a2149da97d.tar.gz | |
Merge branch 'feature/826-healthcheck-endpoint' into 'develop'
Feature/826 healthcheck endpoint
Closes #826
See merge request pleroma/pleroma!1083
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/pleroma_api.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md index dbe250300..4b8062d37 100644 --- a/docs/api/pleroma_api.md +++ b/docs/api/pleroma_api.md @@ -197,3 +197,20 @@ See [Admin-API](Admin-API.md) * `remote`: BOOLEAN field, receives notifications from people on remote instances * `local`: BOOLEAN field, receives notifications from people on the local instance * Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}` + +## `/api/pleroma/healthcheck` +### Healthcheck endpoint with additional system data. +* Method `GET` +* Authentication: not required +* Params: none +* Response: JSON, statuses (200 - healthy, 503 unhealthy). +* Example response: +```json +{ + "pool_size": 0, # database connection pool + "active": 0, # active processes + "idle": 0, # idle processes + "memory_used": 0.00, # Memory used + "healthy": true # Instance state +} +``` |