2016-11-24 03:16:24 -06:00
|
|
|
+++
|
|
|
|
title = "Other HTTP API "
|
|
|
|
description = "Grafana Other HTTP API"
|
|
|
|
keywords = ["grafana", "http", "documentation", "api", "other"]
|
2019-12-30 01:17:03 -06:00
|
|
|
aliases = ["/docs/grafana/latest/http_api/other/"]
|
2016-11-24 03:16:24 -06:00
|
|
|
type = "docs"
|
|
|
|
[menu.docs]
|
|
|
|
name = "Other"
|
|
|
|
parent = "http_api"
|
|
|
|
+++
|
|
|
|
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
# Frontend Settings API
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Get Settings
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`GET /api/frontend/settings`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
2017-10-05 12:01:03 -05:00
|
|
|
```http
|
|
|
|
GET /api/frontend/settings HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
```
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
2017-10-05 12:01:03 -05:00
|
|
|
```http
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{
|
|
|
|
"allowOrgCreate":true,
|
|
|
|
"appSubUrl":"",
|
|
|
|
"buildInfo":{
|
|
|
|
"buildstamp":xxxxxx,
|
|
|
|
"commit":"vyyyy",
|
|
|
|
"version":"zzzzz"
|
|
|
|
},
|
|
|
|
"datasources":{
|
|
|
|
"datasourcename":{
|
|
|
|
"index":"grafana-dash",
|
|
|
|
"meta":{
|
|
|
|
"annotations":true,
|
|
|
|
"module":"plugins/datasource/grafana/datasource",
|
|
|
|
"name":"Grafana",
|
|
|
|
"partials":{
|
|
|
|
"annotations":"app/plugins/datasource/grafana/partials/annotations.editor.html",
|
|
|
|
"config":"app/plugins/datasource/grafana/partials/config.html"
|
|
|
|
},
|
|
|
|
"pluginType":"datasource",
|
|
|
|
"serviceName":"Grafana",
|
|
|
|
"type":"grafanasearch"
|
|
|
|
}
|
2016-02-03 00:59:22 -06:00
|
|
|
}
|
2017-10-05 12:01:03 -05:00
|
|
|
},
|
|
|
|
"defaultDatasource": "Grafana"
|
|
|
|
}
|
|
|
|
```
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
# Login API
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Renew session based on remember cookie
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`GET /api/login/ping`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
2017-10-05 12:01:03 -05:00
|
|
|
```http
|
|
|
|
GET /api/login/ping HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
```
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
2017-10-05 12:01:03 -05:00
|
|
|
```http
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2017-10-05 12:01:03 -05:00
|
|
|
{"message": "Logged in"}
|
2019-01-25 10:52:28 -06:00
|
|
|
```
|
|
|
|
|
|
|
|
# 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"
|
|
|
|
}
|
|
|
|
```
|