Browse Source

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

Document /api/health
Torkel Ödegaard 7 years ago
parent
commit
ecbda1af23
1 changed files with 26 additions and 1 deletions
  1. 26 1
      docs/sources/http_api/other.md

+ 26 - 1
docs/sources/http_api/other.md

@@ -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"
+}
+```