API Data Provider - Online Help

Connecting to Grafana

Grafana uses token authentication to control access to the API.

Using Token Authentication

In order to authenticate to Grafana, you'll need to provide your Service Account Token. To create your Service Account Token, in your Grafana account, open the sidemenu and click the Administration dropdown and select "Users and Access" followed by the "Service accounts" option. After creating a new service account, access its page, then click "Add service account token". On older versions of Grafana, using an APIKey may still be possible. If your instance was recently updated, there will be an option to migrate API keys to service accounts under the API Keys section. Additionally, you will need to set the Domain, found in the url of your Grafana account. For example if your Grafana url is https://acmeinc.grafana.net/, then the Domain should be 'acmeinc'. Set both the Token/APIKey and Domain/URL in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\Grafana.apip;ProfileSettings='Domain=acmeinc;Token=my_token';

If the domain is of the form (domain).grafana.net, use the Domain property as shown above. If using a self-hosted Grafana instance, use the Url property in ProfileSettings instead.
Profile=C:\profiles\Grafana.apip;ProfileSettings='URL=http://localhost:3000;Token=my_token';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your Grafana API Token. In newer versions of Grafana, this property is deprecated in favor of Token .
Domain The domain for the Grafana account.
Token Your Grafana Service Account Token.
URL URL of the Grafana instance.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9300.0