2016-02-03 00:59:22 -06:00
|
|
|
----
|
2016-02-05 03:47:34 -06:00
|
|
|
page_title: Data source API
|
|
|
|
page_description: Grafana Data source API Reference
|
|
|
|
page_keywords: grafana, admin, http, api, documentation, datasource
|
2016-02-03 00:59:22 -06:00
|
|
|
---
|
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
# Data source API
|
2016-02-03 00:59:22 -06:00
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Get all datasources
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`GET /api/datasources`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
|
|
|
GET /api/datasources HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
[
|
|
|
|
{
|
|
|
|
"id":1,
|
|
|
|
"orgId":1,
|
|
|
|
"name":"datasource_elastic",
|
|
|
|
"type":"elasticsearch",
|
|
|
|
"access":"proxy",
|
|
|
|
"url":"http://mydatasource.com",
|
|
|
|
"password":"",
|
|
|
|
"user":"",
|
|
|
|
"database":"grafana-dash",
|
|
|
|
"basicAuth":false,
|
|
|
|
"basicAuthUser":"",
|
|
|
|
"basicAuthPassword":"",
|
|
|
|
"isDefault":false,
|
|
|
|
"jsonData":null
|
|
|
|
}
|
|
|
|
]
|
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Get a single data sources by Id
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`GET /api/datasources/:datasourceId`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
|
|
|
GET /api/datasources/1 HTTP/1.1
|
2016-03-08 04:19:52 -06:00
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{
|
|
|
|
"id":1,
|
|
|
|
"orgId":1,
|
|
|
|
"name":"test_datasource",
|
|
|
|
"type":"graphite",
|
|
|
|
"access":"proxy",
|
|
|
|
"url":"http://mydatasource.com",
|
|
|
|
"password":"",
|
|
|
|
"user":"",
|
|
|
|
"database":"",
|
|
|
|
"basicAuth":false,
|
|
|
|
"basicAuthUser":"",
|
|
|
|
"basicAuthPassword":"",
|
|
|
|
"isDefault":false,
|
|
|
|
"jsonData":null
|
|
|
|
}
|
|
|
|
|
|
|
|
## Get a single data sources by Name
|
|
|
|
|
|
|
|
`GET /api/datasources/name/:name`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
|
|
|
GET /api/datasources/name/test_datasource HTTP/1.1
|
2016-02-03 00:59:22 -06:00
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{
|
|
|
|
"id":1,
|
|
|
|
"orgId":1,
|
|
|
|
"name":"test_datasource",
|
|
|
|
"type":"graphite",
|
|
|
|
"access":"proxy",
|
|
|
|
"url":"http://mydatasource.com",
|
|
|
|
"password":"",
|
|
|
|
"user":"",
|
|
|
|
"database":"",
|
|
|
|
"basicAuth":false,
|
|
|
|
"basicAuthUser":"",
|
|
|
|
"basicAuthPassword":"",
|
|
|
|
"isDefault":false,
|
|
|
|
"jsonData":null
|
|
|
|
}
|
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Create data source
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`POST /api/datasources`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
|
|
|
POST /api/datasources HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
{
|
|
|
|
"name":"test_datasource",
|
|
|
|
"type":"graphite",
|
|
|
|
"url":"http://mydatasource.com",
|
|
|
|
"access":"proxy",
|
|
|
|
"basicAuth":false
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{"id":1,"message":"Datasource added"}
|
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Update an existing data source
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`PUT /api/datasources/:datasourceId`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
|
|
|
PUT /api/datasources/1 HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
{
|
|
|
|
"id":1,
|
|
|
|
"orgId":1,
|
|
|
|
"name":"test_datasource",
|
|
|
|
"type":"graphite",
|
|
|
|
"access":"proxy",
|
|
|
|
"url":"http://mydatasource.com",
|
|
|
|
"password":"",
|
|
|
|
"user":"",
|
|
|
|
"database":"",
|
|
|
|
"basicAuth":true,
|
|
|
|
"basicAuthUser":"basicuser",
|
|
|
|
"basicAuthPassword":"basicuser",
|
|
|
|
"isDefault":false,
|
|
|
|
"jsonData":null
|
|
|
|
}
|
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{"message":"Datasource updated"}
|
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Delete an existing data source
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`DELETE /api/datasources/:datasourceId`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
|
|
|
DELETE /api/datasources/1 HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{"message":"Data source deleted"}
|
|
|
|
|
2016-02-05 03:47:34 -06:00
|
|
|
## Available data source types
|
2016-02-03 00:59:22 -06:00
|
|
|
|
|
|
|
`GET /api/datasources/plugins`
|
|
|
|
|
|
|
|
**Example Request**:
|
|
|
|
|
|
|
|
GET /api/datasources/plugins HTTP/1.1
|
|
|
|
Accept: application/json
|
|
|
|
Content-Type: application/json
|
|
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
|
|
|
|
|
|
**Example Response**:
|
|
|
|
|
|
|
|
HTTP/1.1 200
|
|
|
|
Content-Type: application/json
|
|
|
|
|
|
|
|
{
|
|
|
|
"grafana":{
|
|
|
|
"metrics":true,"module":"plugins/datasource/grafana/datasource",
|
|
|
|
"name":"Grafana (for testing)",
|
|
|
|
"partials":{
|
|
|
|
"query":"app/plugins/datasource/grafana/partials/query.editor.html"
|
|
|
|
},
|
|
|
|
"pluginType":"datasource",
|
|
|
|
"serviceName":"GrafanaDatasource",
|
|
|
|
"type":"grafana"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
## Data source proxy calls
|
|
|
|
|
|
|
|
`GET /api/datasources/proxy/:datasourceId/*`
|
|
|
|
|
|
|
|
Proxies all calls to the actual datasource.
|