Find Grafana Datasource ID by Name

Identifying the unique identifier (ID) of a datasource in Grafana is essential for interacting with its configuration via the Grafana API. This process is useful for automation and integration tasks where direct access to the datasource's ID is required.

For more details, refer to the official Grafana HTTP API documentation.

 Instructions

Prerequisites

Before retrieving the Grafana datasource ID, ensure the following:

1. Grafana Server Access: Ensure network access to the Grafana instance, with the correct IP and port.

2. User Credentials: A valid username and password with permission to access the API.

3. Datasource Name: You must know the exact name of the datasource whose ID you wish to retrieve.

4. Command-line Tools:

   • curl: To send HTTP requests.

   • jq: (Optional) A tool to parse JSON responses. If not installed, the full response will be returned.

Instructions

1. Get the Datasource ID by Name: Replace the variables (admin, 10.2.7.100, adminz-password, 80, hivemq-prometheus-1) with your actual Grafana details and run the following command:

   curl -s -u "admin:adminz-password" "http://10.2.7.100:80/api/datasources/name/hivemq-prometheus-1" | jq '.id'

2. Expected Output: The command will return the datasource ID as a JSON response. For example:

   11

3. Error Messages:

   • Connection Error: curl: (7) Failed to connect

   • Invalid Credentials: {"message": "invalid username or password"}

   • Unauthorized: {"message": "Unauthorized"}

4. List All Datasources: To list all available datasources, use the following command:

   curl -s -u "admin:adminz-password" "http://10.2.7.100:80/api/datasources"

 Related articles