Skip to content

N
nexpie-grafana-theme
Commit 3f48033b by Sofia Papagiannaki Committed by GitHub
Options

Docs: Update datasource API examples (#20951) 

* Update requests and responses

* Add basic auth example
parent 0e4850f2
Showing with 191 additions and 55 deletions
docs/sources/http_api/data_source.md
...@@ -32,22 +32,28 @@ HTTP/1.1 200 ...@@ -32,22 +32,28 @@ HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
[ [
{ {
"id":1, "id": 1,
"orgId":1, "orgId": 1,
"name":"datasource_elastic", "name": "datasource_elastic",
"type":"elasticsearch", "type": "elasticsearch",
"access":"proxy", "typeLogoUrl": "public/app/plugins/datasource/elasticsearch/img/elasticsearch.svg",
"url":"http://mydatasource.com", "access": "proxy",
"password":"", "url": "http://mydatasource.com",
"user":"", "password": "",
"database":"grafana-dash", "user": "",
"basicAuth":false, "database": "grafana-dash",
"basicAuthUser":"", "basicAuth": false,
"basicAuthPassword":"", "isDefault": false,
"isDefault":false, "jsonData": {
"jsonData":null "esVersion": 5,
} "logLevelField": "",
"logMessageField": "",
"maxConcurrentShardRequests": 256,
"timeField": "@timestamp"
},
"readOnly": false
}
] ]
``` ```
...@@ -71,20 +77,28 @@ HTTP/1.1 200 ...@@ -71,20 +77,28 @@ HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"id":1, "id": 1,
"orgId":1, "orgId": 1,
"name":"test_datasource", "name": "test_datasource",
"type":"graphite", "type": "graphite",
"access":"proxy", "typeLogoUrl": "",
"url":"http://mydatasource.com", "access": "proxy",
"password":"", "url": "http://mydatasource.com",
"user":"", "password": "",
"database":"", "user": "",
"basicAuth":false, "database": "",
"basicAuthUser":"", "basicAuth": false,
"basicAuthPassword":"", "basicAuthUser": "",
"isDefault":false, "basicAuthPassword": "",
"jsonData":null "withCredentials": false,
"isDefault": false,
"jsonData": {
"graphiteType": "default",
"graphiteVersion": "1.1"
},
"secureJsonFields": {},
"version": 1,
"readOnly": false
} }
``` ```
...@@ -108,20 +122,28 @@ HTTP/1.1 200 ...@@ -108,20 +122,28 @@ HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{ {
"id":1, "id": 1,
"orgId":1, "orgId": 1,
"name":"test_datasource", "name": "test_datasource",
"type":"graphite", "type": "graphite",
"access":"proxy", "typeLogoUrl": "",
"url":"http://mydatasource.com", "access": "proxy",
"password":"", "url": "http://mydatasource.com",
"user":"", "password": "",
"database":"", "user": "",
"basicAuth":false, "database": "",
"basicAuthUser":"", "basicAuth": false,
"basicAuthPassword":"", "basicAuthUser": "",
"isDefault":false, "basicAuthPassword": "",
"jsonData":null "withCredentials": false,
"isDefault": false,
"jsonData": {
"graphiteType": "default",
"graphiteVersion": "1.1"
},
"secureJsonFields": {},
"version": 1,
"readOnly": false
} }
``` ```
...@@ -170,6 +192,98 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -170,6 +192,98 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
} }
``` ```
**Example Graphite Response**:
```http
HTTP/1.1 200
Content-Type: application/json
{
"datasource": {
"id": 1,
"orgId": 1,
"name": "test_datasource",
"type": "graphite",
"typeLogoUrl": "",
"access": "proxy",
"url": "http://mydatasource.com",
"password": "",
"user": "",
"database": "",
"basicAuth": false,
"basicAuthUser": "",
"basicAuthPassword": "",
"withCredentials": false,
"isDefault": false,
"jsonData": {},
"secureJsonFields": {},
"version": 1,
"readOnly": false
},
"id": 1,
"message": "Datasource added",
"name": "test_datasource"
}
```
> NOTE: `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response. See also the [Encrypting Sensitive Data]({{< relref "../plugins/developing/auth-for-datasources.md/#encrypting-sensitive-data">}}) documentation for more details.
**Example Graphite Request with basic auth enabled**:
```http
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": true,
"basicAuthUser": "basicuser",
"secureJsonData": {
"basicAuthPassword": "basicpassword"
}
}
```
**Example Response with basic auth enabled**:
```http
HTTP/1.1 200
Content-Type: application/json
{
"datasource": {
"id": 1,
"orgId": 1,
"name": "test_datasource",
"type": "graphite",
"typeLogoUrl": "",
"access": "proxy",
"url": "http://mydatasource.com",
"password": "",
"user": "",
"database": "",
"basicAuth": true,
"basicAuthUser": "basicuser",
"basicAuthPassword": "",
"withCredentials": false,
"isDefault": false,
"jsonData": {},
"secureJsonFields": {
"basicAuthPassword": true
},
"version": 1,
"readOnly": false
},
"id": 102,
"message": "Datasource added",
"name": "test_datasource"
}
```
**Example CloudWatch Request**: **Example CloudWatch Request**:
```http ```http
...@@ -194,15 +308,6 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -194,15 +308,6 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
} }
``` ```
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
{"id":1,"message":"Datasource added", "name": "test_datasource"}
```
## Update an existing data source ## Update an existing data source
`PUT /api/datasources/:datasourceId` `PUT /api/datasources/:datasourceId`
...@@ -227,7 +332,9 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -227,7 +332,9 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
"database":"", "database":"",
"basicAuth":true, "basicAuth":true,
"basicAuthUser":"basicuser", "basicAuthUser":"basicuser",
"basicAuthPassword":"basicuser", "secureJsonData": {
"basicAuthPassword": "basicpassword"
},
"isDefault":false, "isDefault":false,
"jsonData":null "jsonData":null
} }
...@@ -239,9 +346,38 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ...@@ -239,9 +346,38 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
HTTP/1.1 200 HTTP/1.1 200
Content-Type: application/json Content-Type: application/json
{"message":"Datasource updated", "id": 1, "name": "test_datasource"} {
"datasource": {
"id": 1,
"orgId": 1,
"name": "test_datasource",
"type": "graphite",
"typeLogoUrl": "",
"access": "proxy",
"url": "http://mydatasource.com",
"password": "",
"user": "",
"database": "",
"basicAuth": true,
"basicAuthUser": "basicuser",
"basicAuthPassword": "",
"withCredentials": false,
"isDefault": false,
"jsonData": {},
"secureJsonFields": {
"basicAuthPassword": true
},
"version": 1,
"readOnly": false
},
"id": 102,
"message": "Datasource updated",
"name": "test_datasource"
}
``` ```
> NOTE: Similar to [creating a data source](#create-a-data-source), `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response. See also the [Encrypting Sensitive Data]({{< relref "../plugins/developing/auth-for-datasources.md/#encrypting-sensitive-data">}}) documentation for more details.
## Delete an existing data source by id ## Delete an existing data source by id
`DELETE /api/datasources/:datasourceId` `DELETE /api/datasources/:datasourceId`
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment