Skip to main content

Grafana® - Tutorial: How to Use the Grafana® API

Stephanie R.
Updated

Learn how to configure Grafana® to use the API and how to make calls to the exposed API.

 

Requirements

 

Instructions

Create a Grafana® service account

From the Grafana® user interface, select Home, Administration, and Service Accounts.

Then, select Add Service Account.

DBaaS_grafana_useAPIs01.png

Create a new service account sa-editor with the role Editor.

Click Create.

DBaaS_grafana_useAPIs02.png

Click on Add service account token:

DBaaS_grafana_useAPIs03.png

Enter the name of the desired token, grafana-sa-token-editor, and click on Generate token:

DBaaS_grafana_useAPIs04.png

Copy the generated token.

NOTE: After closing the pop-up, you will no longer be able to display the token!

DBaaS_grafana_useAPIs05**.png

The created token appears in the tokens list:

DBaaS_grafana_useAPIs06.png

 

Create a folder

Before using the Grafana® API, you must have at least one folder on your Dashboard. To create one, click Dashboard in the left-hand navigation menu. Then click New and select New Folder.

grafana-new-folder1.png

Give your folder a name, then click Create.

grafana-new-folder2.png

You are ready to use this token with the Grafana® API.

 

Use the Grafana® API

Detailed instructions on how to use the API and the possible actions can be found in the official documentation.
NOTE: Don't forget to set the Authorized IP addresses in the Grafana® configuration. See our Grafana® - Configure an Instance to Accept Incoming Connections guide for more details.

To send a request to the API you must use the previously created token and set it in the request header as a "Bearer token":

export GRAFANA_API_TOKEN=042footoken420

curl -H "Authorization: Bearer $GRAFANA_API_TOKEN" https://grafana-xxxxxxxxx-yyyyyyyyy.database.cloud.ovh.us/api/folders    
[
    {
        "id":11,
        "uid":"HnDCAp-4k",
        "title":"foo 1"
    },
    {
        "id":5,
        "uid":"cb_S6Pb4k",
        "title":"foo 2"
    },
    {
        "id":9,
        "uid":"Xav55taVk",
        "title":"foo 3"
    },
    {
        "id":10,
        "uid":"AH8sApaVz",
        "title":"foo 4"
    }
]
Congratulations! You can now use all the power of the Grafana® API.

 

Go further

For more information and tutorials, please see our other Cloud Databases support guides or explore the guides for other OVHcloud products and services.

[1]: The Grafana Labs Marks are trademarks of Grafana Labs, and are used with Grafana Labs’ permission. We are not affiliated with, endorsed or sponsored by Grafana Labs or its affiliates.

Related articles