Data source API

    Example Request:

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. [
    5.    {
    6.      "id": 1,
    7.      "orgId": 1,
    8.      "uid": "H8joYFVGz"
    9.      "name": "datasource_elastic",
    10.      "type": "elasticsearch",
    11.      "typeLogoUrl": "public/app/plugins/datasource/elasticsearch/img/elasticsearch.svg",
    12.      "access": "proxy",
    13.      "url": "http://mydatasource.com",
    14.      "password": "",
    15.      "user": "",
    16.      "database": "grafana-dash",
    17.      "basicAuth": false,
    18.      "isDefault": false,
    19.      "jsonData": {
    20.          "esVersion": 5,
    21.          "logLevelField": "",
    22.          "logMessageField": "",
    23.          "maxConcurrentShardRequests": 256,
    24.          "timeField": "@timestamp"
    25.      },
    26.      "readOnly": false
    27.    }
    28. ]

    Get a single data source by Id

    GET /api/datasources/:datasourceId

    Example Request:

    1. GET /api/datasources/1 HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "id": 1,
    6.   "uid": "kLtEtcRGk",
    7.   "orgId": 1,
    8.   "name": "test_datasource",
    9.   "type": "graphite",
    10.   "typeLogoUrl": "",
    11.   "access": "proxy",
    12.   "url": "http://mydatasource.com",
    13.   "password": "",
    14.   "user": "",
    15.   "database": "",
    16.   "basicAuth": false,
    17.   "basicAuthUser": "",
    18.   "basicAuthPassword": "",
    19.   "withCredentials": false,
    20.   "isDefault": false,
    21.   "jsonData": {
    22.     "graphiteType": "default",
    23.     "graphiteVersion": "1.1"
    24.   },
    25.   "secureJsonFields": {},
    26.   "version": 1,
    27.   "readOnly": false
    28. }

    Get a single data source by UID

    GET /api/datasources/uid/:uid

    Example request:

    1. GET /api/datasources/uid/kLtEtcRGk HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "id": 1,
    6.   "uid": "kLtEtcRGk",
    7.   "orgId": 1,
    8.   "name": "test_datasource",
    9.   "type": "graphite",
    10.   "typeLogoUrl": "",
    11.   "access": "proxy",
    12.   "url": "http://mydatasource.com",
    13.   "password": "",
    14.   "user": "",
    15.   "database": "",
    16.   "basicAuth": false,
    17.   "basicAuthUser": "",
    18.   "basicAuthPassword": "",
    19.   "withCredentials": false,
    20.   "isDefault": false,
    21.   "jsonData": {
    22.     "graphiteType": "default",
    23.     "graphiteVersion": "1.1"
    24.   },
    25.   "secureJsonFields": {},
    26.   "version": 1,
    27.   "readOnly": false
    28. }

    Get a single data source by Name

    GET /api/datasources/name/:name

    Example Request:

    1. GET /api/datasources/name/test_datasource HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "id": 1,
    6.   "uid": "kLtEtcRGk",
    7.   "orgId": 1,
    8.   "name": "test_datasource",
    9.   "type": "graphite",
    10.   "typeLogoUrl": "",
    11.   "access": "proxy",
    12.   "password": "",
    13.   "user": "",
    14.   "database": "",
    15.   "basicAuth": false,
    16.   "basicAuthUser": "",
    17.   "basicAuthPassword": "",
    18.   "withCredentials": false,
    19.   "isDefault": false,
    20.   "jsonData": {
    21.     "graphiteType": "default",
    22.     "graphiteVersion": "1.1"
    24.   "secureJsonFields": {},
    25.   "version": 1,
    26.   "readOnly": false
    27. }

    GET /api/datasources/id/:name

    Example Request:

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "id":1
    6. }

    Create a data source

    Example Graphite Request:

    1. POST /api/datasources HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {
    7.   "name":"test_datasource",
    8.   "type":"graphite",
    9.   "url":"http://mydatasource.com",
    10.   "access":"proxy",
    11.   "basicAuth":false
    12. }

    Example Graphite Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "datasource": {
    6.     "id": 1,
    7.     "orgId": 1,
    8.     "name": "test_datasource",
    9.     "type": "graphite",
    10.     "typeLogoUrl": "",
    11.     "access": "proxy",
    12.     "url": "http://mydatasource.com",
    13.     "password": "",
    14.     "user": "",
    15.     "database": "",
    16.     "basicAuth": false,
    17.     "basicAuthUser": "",
    18.     "basicAuthPassword": "",
    19.     "withCredentials": false,
    20.     "isDefault": false,
    21.     "jsonData": {},
    22.     "secureJsonFields": {},
    23.     "version": 1,
    24.     "readOnly": false
    25.   },
    26.   "id": 1,
    27.   "message": "Datasource added",
    28.   "name": "test_datasource"
    29. }

    Example Graphite Request with basic auth enabled:

    1. POST /api/datasources HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {
    7.   "name": "test_datasource",
    8.   "type": "graphite",
    9.   "url": "http://mydatasource.com",
    10.   "access": "proxy",
    11.   "basicAuth": true,
    12.   "basicAuthUser": "basicuser",
    13.   "secureJsonData": {
    14.     "basicAuthPassword": "basicpassword"
    15.   }
    16. }

    Example Response with basic auth enabled:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "datasource": {
    6.     "id": 1,
    7.     "orgId": 1,
    8.     "name": "test_datasource",
    9.     "type": "graphite",
    10.     "typeLogoUrl": "",
    11.     "access": "proxy",
    12.     "url": "http://mydatasource.com",
    13.     "password": "",
    14.     "user": "",
    15.     "database": "",
    16.     "basicAuth": true,
    17.     "basicAuthUser": "basicuser",
    18.     "basicAuthPassword": "",
    19.     "withCredentials": false,
    20.     "isDefault": false,
    21.     "jsonData": {},
    22.     "secureJsonFields": {
    23.       "basicAuthPassword": true
    24.     },
    25.     "version": 1,
    26.     "readOnly": false
    27.   },
    28.   "id": 102,
    29.   "message": "Datasource added",
    30.   "name": "test_datasource"
    31. }

    Example CloudWatch Request:

    1. POST /api/datasources HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {
    7.   "name": "test_datasource",
    8.   "type": "cloudwatch",
    9.   "url": "http://monitoring.us-west-1.amazonaws.com",
    10.   "jsonData": {
    11.     "authType": "keys",
    12.     "defaultRegion": "us-west-1"
    13.   },
    14.   "secureJsonData": {
    15.     "accessKey": "Ol4pIDpeKSA6XikgOl4p",
    16.     "secretKey": "dGVzdCBrZXkgYmxlYXNlIGRvbid0IHN0ZWFs"
    17.   }

    Update an existing data source

    PUT /api/datasources/:datasourceId

    Example Request:

    1. PUT /api/datasources/1 HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {
    7.   "id":1,
    8.   "orgId":1,
    9.   "name":"test_datasource",
    10.   "type":"graphite",
    11.   "access":"proxy",
    12.   "url":"http://mydatasource.com",
    13.   "password":"",
    14.   "user":"",
    15.   "database":"",
    16.   "basicAuth":true,
    17.   "basicAuthUser":"basicuser",
    18.   "secureJsonData": {
    19.     "basicAuthPassword": "basicpassword"
    20.   },
    21.   "isDefault":false,
    22.   "jsonData":null
    23. }

    Example Response:

    Delete an existing data source by id

    DELETE /api/datasources/:datasourceId

    Example Request:

    1. DELETE /api/datasources/1 HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {"message":"Data source deleted"}

    DELETE /api/datasources/uid/:uid

    1. DELETE /api/datasources/uid/kLtEtcRGk HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {"message":"Data source deleted"}

    Delete an existing data source by name

    DELETE /api/datasources/name/:datasourceName

    Example Request:

    1. DELETE /api/datasources/name/test_datasource HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "message":"Data source deleted",
    6.   "id": 1
    7. }

    Data source proxy calls

    GET /api/datasources/proxy/:datasourceId/*

    Proxies all calls to the actual data source.

    Query a data source by ID

    Queries a data source having backend implementation.

    POST /api/tsdb/query

    Example Request:

    1. POST /api/tsdb/query HTTP/1.1
    2. Accept: application/json
    3. Content-Type: application/json
    5. {
    6.   "from": "1420066800000",
    7.   "to": "1575845999999",
    8.   "queries": [
    9.     {
    10.       "refId": "A",
    11.       "intervalMs": 86400000,
    12.       "maxDataPoints": 1092,
    13.       "datasourceId": 86,
    14.       "rawSql": "SELECT 1 as valueOne, 2 as valueTwo",
    15.       "format": "table"
    16.     }
    17.   ]
    18. }

    JSON Body schema:

    • from/to – Should be either absolute in epoch timestamps in milliseconds or relative using Grafana time units. For example, now-1h.
    • queries.refId – Specifies an identifier of the query. Is optional and default to “A”.
    • queries.datasourceId – Specifies the data source to be queried. Each query in the request must have an unique datasourceId.
    • queries.maxDataPoints - Species maximum amount of data points that dashboard panel can render. Is optional and default to 100.
    • queries.intervalMs - Specifies the time interval in milliseconds of time series. Is optional and defaults to 1000.

    In addition, each data source has its own specific properties that should be added in a request.

    Example request for the MySQL data source:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "results": {
    6.     "A": {
    7.       "refId": "A",
    8.       "meta": {
    9.         "rowCount": 0,
    10.         "sql": "SELECT\n  time,\n  sum(opened) AS \"Opened\",\n  sum(closed) AS \"Closed\"\nFROM\n  issues_activity\nWHERE\n  time >= 1420066800 AND time <= 1575845999 AND\n  period = 'm' AND\n  repo IN('grafana/grafana') AND\n  opened_by IN('Contributor','Grafana Labs')\nGROUP BY 1\nORDER BY 1\n"
    11.       },
    12.       "series": [
    13.         {
    14.           "name": "Opened",
    15.           "points": [
    16.             [
    17.               109,
    18.               1420070400000
    19.             ],
    20.             [
    21.               122,
    22.               1422748800000
    23.             ]
    24.           ]
    25.         },
    26.         {
    27.           "name": "Closed",
    28.           "points": [
    29.             [
    30.               89,
    31.               1420070400000
    32.             ]
    33.           ]
    34.         }
    35.       ]
    36.     }
    37.   }