Data source API

Get all datasources

GET /api/datasources

Example Request:

  1. GET /api/datasources 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.   {
  6.     "id":1,
  7.     "orgId":1,
  8.     "name":"datasource_elastic",
  9.     "type":"elasticsearch",
  10.     "access":"proxy",
  11.     "url":"http://mydatasource.com",
  12.     "password":"",
  13.     "user":"",
  14.     "database":"grafana-dash",
  15.     "basicAuth":false,
  16.     "basicAuthUser":"",
  17.     "basicAuthPassword":"",
  18.     "isDefault":false,
  19.     "jsonData":null
  20.   }
  21. ]

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.   "orgId":1,
  7.   "name":"test_datasource",
  8.   "type":"graphite",
  9.   "access":"proxy",
  10.   "url":"http://mydatasource.com",
  11.   "password":"",
  12.   "user":"",
  13.   "database":"",
  14.   "basicAuth":false,
  15.   "basicAuthUser":"",
  16.   "basicAuthPassword":"",
  17.   "isDefault":false,
  18.   "jsonData":null
  19. }

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.   "orgId":1,
  7.   "name":"test_datasource",
  8.   "type":"graphite",
  9.   "access":"proxy",
  10.   "url":"http://mydatasource.com",
  11.   "password":"",
  12.   "user":"",
  13.   "database":"",
  14.   "basicAuth":false,
  15.   "basicAuthUser":"",
  16.   "basicAuthPassword":"",
  17.   "isDefault":false,
  18.   "jsonData":null
  19. }

Get data source Id by Name

GET /api/datasources/id/:name

Example Request:

  1. GET /api/datasources/id/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. }

Create a data source

POST /api/datasources

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 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.   "access": "proxy",
  11.   "jsonData": {
  12.     "authType": "keys",
  13.     "defaultRegion": "us-west-1"
  14.   },
  15.   "secureJsonData": {
  16.     "accessKey": "Ol4pIDpeKSA6XikgOl4p",
  17.     "secretKey": "dGVzdCBrZXkgYmxlYXNlIGRvbid0IHN0ZWFs"
  18.   }
  19. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {"id":1,"message":"Datasource added", "name": "test_datasource"}

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.   "basicAuthPassword":"basicuser",
  19.   "isDefault":false,
  20.   "jsonData":null
  21. }

Example Response:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  4. {"message":"Datasource updated", "id": 1, "name": "test_datasource"}

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 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. {"message":"Data source deleted"}

Data source proxy calls

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

Proxies all calls to the actual datasource.