Merge pull request #15068 from finkr/finkr-patch-doc-healthapi

Document /api/health
2019-01-26 07:06:03 +01:00
parent aaad9e3e49 1fc5ea181a
commit ecbda1af23
1 changed files with 26 additions and 1 deletions
@@ -82,4 +82,29 @@ HTTP/1.1 200
 Content-Type: application/json

 {"message": "Logged in"}
-```
+```
+
+# Health API
+
+## Returns health information about Grafana
+
+`GET /api/health`
+
+**Example Request**
+
+```http
+GET /api/health
+Accept: application/json
+```
+
+**Example Response**:
+
+```http
+HTTP/1.1 200 OK
+
+{
+  "commit": "087143285",
+  "database": "ok",
+  "version": "5.1.3"
+}
+```