Skip to main content

Dashboards - 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® home screen, select Administration, Users and access, then Service Accounts.

Click Add Service Account.

grafana_serviceAccounts.png

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

Click Create.

grafana_createServiceAccount.png

Click on Add service account token:

grafana_serviceAcountDetails.png

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

grafana_addToken.png

Copy the generated token.

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

grafana_serviceToken.png

The created token appears in the tokens list:

grafana_serviceAcountDetails_withToken.png

 

Create a folder

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

grafana_dashboards_new.png

Give your folder a name, then click Create.

grafana_dashboards_newFolder.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 Configure your Dashboards 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 Managed Databases & Analytics or Platform as a Service guides. You can also explore the guides for other OVHcloud products and services.

OVHcloud Managed Databases and Analytics:

  • Grafana® is a registered trademark of Grafana Labs and is used with the permission of Grafana Labs. OVH SAS and its subsidiaries are not affiliated with or endorsed by Grafana Labs.
  • Kafka® is a registered trademark of The Apache Software Foundation and has been licensed for use by OVHcloud, who has no affiliation with and is not endorsed by The Apache Software Foundation.
  • MongoDB® is a registered trademark of MongoDB, Inc.
  • MySQL® is a registered trademark of Oracle and/or its affiliates.
  • PostgreSQL® is a registered trademark of the PostgreSQL Community Association of Canada.

Related articles