Docs: Moves http api docs to the developer docs (#49255)
* updates relrefs after move Co-authored-by: Chris Moyer <chris.moyer@grafana.com> * applies weights Co-authored-by: Chris Moyer <chris.moyer@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * updates developer _index page * make prettier Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
co-authored by
Chris Moyer
Jack Baldry
parent
3d5d8c785b
commit
ee9ea64834
@@ -0,0 +1,105 @@
|
||||
+++
|
||||
aliases = ["/docs/grafana/latest/http_api/other/"]
|
||||
description = "Grafana Other HTTP API"
|
||||
keywords = ["grafana", "http", "documentation", "api", "other"]
|
||||
title = "Other HTTP API "
|
||||
+++
|
||||
|
||||
# Frontend Settings API
|
||||
|
||||
## Get Settings
|
||||
|
||||
`GET /api/frontend/settings`
|
||||
|
||||
**Example Request**:
|
||||
|
||||
```http
|
||||
GET /api/frontend/settings HTTP/1.1
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
```
|
||||
|
||||
**Example Response**:
|
||||
|
||||
```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"
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultDatasource": "Grafana"
|
||||
}
|
||||
```
|
||||
|
||||
# Login API
|
||||
|
||||
## Renew session based on remember cookie
|
||||
|
||||
`GET /api/login/ping`
|
||||
|
||||
**Example Request**:
|
||||
|
||||
```http
|
||||
GET /api/login/ping HTTP/1.1
|
||||
Accept: application/json
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
```
|
||||
|
||||
**Example Response**:
|
||||
|
||||
```http
|
||||
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"
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user