From 99b2dfde53b141da683b7d469a4180d4c63066b9 Mon Sep 17 00:00:00 2001 From: Atul Varma Date: Fri, 30 Jan 2015 11:53:44 -0500 Subject: [PATCH] documented /healthcheck. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 15b9683..1eb9401 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,16 @@ Body parameters: for pages that need extra time after the `load` event is fired to put themselves together. Defaults to `false`. +#### `GET /healthcheck` + +Returns HTTP 200 if the server is OK, 500 if something is wrong. + +Regardless, this endpoint always returns a JSON response with +the following keys: + +* `redis` is a boolean indicating whether the server is currently + connected to redis. + ## Discourse Support You can use `contrib/discourse-onebox.js` as a basis for automatically