Data Sources API

Manage data source configurations programmatically

Data Sources API

The Data Sources API provides endpoints for managing data source configurations in Grafana.

Get All Data Sources

Retrieve all data sources for the current organization.

cURL

curl -X GET http://localhost:3000/api/datasources \
  -u admin:admin

[
  {
    "id": 1,
    "uid": "P1809F7CD0C75ACF3",
    "orgId": 1,
    "name": "Prometheus",
    "type": "prometheus",
    "typeLogoUrl": "public/app/plugins/datasource/prometheus/img/prometheus_logo.svg",
    "access": "proxy",
    "url": "http://localhost:9090",
    "database": "",
    "user": "",
    "basicAuth": false,
    "isDefault": true,
    "jsonData": {},
    "readOnly": false
  }
]

id · integer

Data source internal ID

uid · string

Data source unique identifier

name · string

Data source name

type · string

Data source type (e.g., “prometheus”, “mysql”, “postgres”)

access · string

Access mode: “proxy” (via Grafana backend) or “direct” (from browser)

url · string

Data source URL

isDefault · boolean

Whether this is the default data source

Get Data Source by UID

Retrieve a single data source by its UID.

cURL

curl -X GET http://localhost:3000/api/datasources/uid/P1809F7CD0C75ACF3 \
  -u admin:admin

{
  "id": 1,
  "uid": "P1809F7CD0C75ACF3",
  "orgId": 1,
  "name": "Prometheus",
  "type": "prometheus",
  "access": "proxy",
  "url": "http://localhost:9090",
  "database": "",
  "user": "",
  "basicAuth": false,
  "isDefault": true,
  "jsonData": {
    "httpMethod": "POST"
  },
  "readOnly": false,
  "version": 1
}

uid · string · required

Data source unique identifier

Create Data Source

Create a new data source.

cURL

curl -X POST http://localhost:3000/api/datasources \
  -u admin:admin \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Prometheus",
    "type": "prometheus",
    "url": "http://localhost:9090",
    "access": "proxy",
    "isDefault": false,
    "jsonData": {
      "httpMethod": "POST"
    }
  }'

{
  "id": 1,
  "uid": "P1809F7CD0C75ACF3",
  "name": "Prometheus",
  "message": "Datasource added",
  "datasource": {
    "id": 1,
    "uid": "P1809F7CD0C75ACF3",
    "name": "Prometheus",
    "type": "prometheus",
    "url": "http://localhost:9090",
    "access": "proxy",
    "isDefault": false
  }
}

name · string · required

Data source name

type · string · required

Data source type (e.g., “prometheus”, “mysql”, “postgres”)

url · string · required

Data source URL

access · string · default: "proxy"

Access mode: “proxy” or “direct”

database · string

Database name (for database data sources)

user · string

Database user (for database data sources)

basicAuth · boolean · default: "false"

Enable basic authentication

basicAuthUser · string

Basic auth username

isDefault · boolean · default: "false"

Set as default data source

jsonData · object

Additional data source configuration (varies by type)

secureJsonData · object

Secure configuration fields (passwords, API keys). These are encrypted when stored.

secureJsonData.password · string

Database password or API password

secureJsonData.basicAuthPassword · string

Basic authentication password

Update Data Source by UID

Update an existing data source.

cURL

curl -X PUT http://localhost:3000/api/datasources/uid/P1809F7CD0C75ACF3 \
  -u admin:admin \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Prometheus Updated",
    "type": "prometheus",
    "url": "http://localhost:9090",
    "access": "proxy",
    "isDefault": false,
    "jsonData": {
      "httpMethod": "POST"
    }
  }'

{
  "message": "Datasource updated",
  "id": 1,
  "name": "Prometheus Updated",
  "datasource": {
    "id": 1,
    "uid": "P1809F7CD0C75ACF3",
    "name": "Prometheus Updated",
    "type": "prometheus"
  }
}

uid · string · required

Data source unique identifier

The request body uses the same parameters as creating a data source.

Delete Data Source by UID

Delete a data source by its UID.

cURL

curl -X DELETE http://localhost:3000/api/datasources/uid/P1809F7CD0C75ACF3 \
  -u admin:admin

{
  "message": "Data source deleted",
  "id": 1
}

uid · string · required

Data source unique identifier

Get Data Source by Name

Retrieve a data source by its name.

cURL

curl -X GET http://localhost:3000/api/datasources/name/Prometheus \
  -u admin:admin

name · string · required

Data source name

This endpoint is deprecated. Use the UID-based endpoint instead.

Get Data Source ID by Name

Retrieve a data source ID by its name.

cURL

curl -X GET http://localhost:3000/api/datasources/id/Prometheus \
  -u admin:admin

{
  "id": 1
}

name · string · required

Data source name

This endpoint is deprecated. Use the UID-based endpoint instead.

Check Data Source Health

Send a health check request to a data source.

cURL

curl -X GET http://localhost:3000/api/datasources/uid/P1809F7CD0C75ACF3/health \
  -u admin:admin

{
  "status": "OK",
  "message": "Data source is working"
}

uid · string · required

Data source unique identifier

status · string

Health status: “OK”, “ERROR”, or “UNKNOWN”

message · string

Health check message

details · object

Additional health check details (optional)

Permissions

If you are running Grafana Enterprise with Fine-grained access control enabled:

• Read: Requires datasources:read permission
• Create: Requires datasources:create permission
• Update: Requires datasources:write permission with scope datasources:uid:<uid>
• Delete: Requires datasources:delete permission with scope datasources:uid:<uid>
• Query: Requires datasources:query permission with scope datasources:uid:<uid>