From 1fc5ea181ad29a9efd9c663c9013286d8c464755 Mon Sep 17 00:00:00 2001 From: Frank lin Piat Date: Fri, 25 Jan 2019 17:52:28 +0100 Subject: [PATCH] Document /api/health Document the health check implemented in #3302 (and #935), see https://github.com/grafana/grafana/issues/3302#issuecomment-297066201 --- docs/sources/http_api/other.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/sources/http_api/other.md b/docs/sources/http_api/other.md index 5bf0cde05fed5..ea905bf88f0bf 100644 --- a/docs/sources/http_api/other.md +++ b/docs/sources/http_api/other.md @@ -82,4 +82,29 @@ HTTP/1.1 200 Content-Type: application/json {"message": "Logged in"} -``` \ No newline at end of file +``` + +# 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" +} +```