Plugins 〉Grafana HTTP API
Grafana HTTP API
Grafana HTTP API Data Source for Grafana
Introduction
The Grafana HTTP API Data Source for Grafana allows retrieving data from local and remote Grafana instances via HTTP API.
Requirements
- Grafana 9 and Grafana 10 are required for major version 2.
- Grafana 8.5 and Grafana 9 are required for major version 1.
Getting Started
The Grafana HTTP API Data Source can be installed from the Grafana Catalog or utilizing the Grafana command line tool.
For the latter, use the following command.
grafana-cli plugins install volkovlabs-grapi-datasource
Authentication
The Grafana HTTP API Data source requires Grafana URL and a Token or API key to establish the connection to the organization and get relevant data.
Highlights
- Connects to Local and Remote Grafana instances via HTTP API using API Keys and Tokens.
- Allows to get Health information.
- Allows to retrieve Annotations, Alerts, and Data Sources.
Documentation
| Section | Description |
|---|---|
| Configuration | Explains configuration settings for the Data Source. |
| Provisioning | Demonstrates how to automatically provision the Data Source. |
| Features | Demonstrates panel features. |
| Release Notes | Stay up to date with the latest features and updates. |
Tutorial
This is an introductory video for anyone interested in Grafana Alerts and Annotations.
Feedback
We're looking forward to hearing from you. You can use different ways to get in touch with us.
- Ask a question, request a new feature, and file a bug with GitHub issues.
- Subscribe to our YouTube Channel and add a comment.
- Sponsor our open-source plugins for Grafana at GitHub Sponsor.
- Support our project by starring the repository.
License
Apache License Version 2.0, see LICENSE.
Grafana Cloud Pro
- $25 / user / month and includes a free trial for new users
- Available with a Grafana Cloud Pro plan
- Access to 1 Enterprise plugin
- Fully managed service (not available to self-manage)
Grafana Cloud Advanced / Grafana Enterprise
- Available with a Grafana Cloud Advanced plan or Grafana Enterprise license
- Access to all Enterprise plugins
- Run fully managed or self-manage on your own infrastructure
Installing Grafana HTTP API on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Data Source
Use the grafana-cli tool to install Grafana HTTP API from the commandline:
grafana-cli plugins install The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Configure the Data Source
Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.
Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.
To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.
Change Log
2.2.0 (2023-09-19)
Features / Enhancements
- Move API methods under feature flag to support various Grafana versions (#53)
- Add an option to disable Alert Rules in Annotations (#55)
- Add a values field from annotation text (#30)
2.1.0 (2023-09-10)
Features / Enhancements
- Refactor API and increase test coverage (#50)
- Update ESLint configuration (#50)
- Add Local mode to access local instance (#51)
- Add Organization Users (#52)
2.0.0 (2023-07-17)
Breaking changes
- Requires Grafana 9 and Grafana 10
Features / Enhancements
- Update to Grafana 10.0.2 (#31, #40, #45, #47)
- Add Annotations Tutorial to README (#33)
- Add Authentication to Getting Started (#36)
- Add exception handling for Alert Rules in Annotations (#39)
- Update tests with testing-library/react (#42)
- Add tests for Components and datasource (#44)
- Migrate to Plugin Tools 1.5.2 (#45)
- Update to Node 18 and npm (#45)
- Add E2E Cypress testing (#48)
1.2.0 (2023-03-30)
Features / Enhancements
- Add formatted Annotation labels for Alerts (#19)
- Update Annotation Limit to 100 by default (#19)
- Add Alert Rules and UID for Alerts Annotations (#20)
- Update Scoped Variables for Annotations (#21)
- Add Variable Support (#25)
- Update provisioning for testing Alerts (#26, #28)
- Add Annotations Tutorial (#29)
1.1.0 (2023-03-15)
Features / Enhancements
- Update to Grafana 9.4.3 (#13)
- Update Bearer token plugin configuration (#13)
- Signed as community plugin (#14)
- Update Grafana types and description (#15)
1.0.0 (2023-03-02)
Features / Enhancements
- Initial release based on Volkov Labs Abc Data source template
- Update README and configuration (#1)
- Add Postgres for Alerting (#2)
- Add Annotations (#3)
- Update name to Grafana HTTP API (#4)
- Improve Annotations and update to Timescale (#5)
- Improve Data Source to check Organization (#6)
- Add Notifications and increase Test Coverage (#7)
- Add Annotation filters (#8)
- Add Annotation Alert States filter (#9)
- Add Health and Data Sources (#10)
- Update README to prepare for the release (#11, #12)
