Plugins 〉JSON API
JSON API
JSON API data source for Grafana
(NOTE: this plugin is now in maintenance mode, no new features will be added. We recommend using the Infinity data source plugin instead)
The Grafana JSON Datasource plugin empowers you to seamlessly integrate JSON data into Grafana. JSON is a versatile and widely used data format, and with this plugin, you can easily transform your JSON data into meaningful visualizations within Grafana dashboards.
Documentation
For comprehensive instructions on setting up and configuring the Grafana JSON API Datasource, please consult our official documentation.
Maintenance: Now the plugin is being maintained by Grafana Labs. Big thanks to Marcus Olsson for the awesome work!
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
.h4 . .mb-0 }
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing JSON 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.
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 JSON 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.
Changelog
v1.3.20 - 2024-11-28
- 🛡️ Security: Update
jsonpath-plus
to version 10.2.0 - 🛡️ Security: Update
cross-spawn
to version 7.0.5
v1.3.19 - 2024-10-29
- 🛡️ Security: Update
jsonpath-plus
to version 10.1.0 - 🛡️ Security: Update
uplot
to version 1.6.31
v1.3.18 - 2024-10-18
- 🛡️ Security: Update
jsonpath-plus
to version 10.0.6 - 🛡️ Security: Bump
dompurify
from 3.1.0 to 3.1.6 - 🛡️ Security: Bump
path-to-regexp
from 1.8.0 to 1.9.0
v1.3.17 - 2024-09-03
- 🛡️ Security: Bump
micromatch
from 4.0.5 to 4.0.8 - 🛡️ Security: Bump
webpack
from 5.86.0 to 5.94.0 - 🛡️ Security: Bump
fast-loops
from 1.1.3 to 1.1.4 - 🛡️ Security: Bump
ws
from 8.14.2 to 8.17.1 - 🛡️ Security: Bump
braces
from 3.0.2 to 3.0.3
v1.3.16 - 2024-06-13
- ⚙️ Fix: Consider
\
(backslash) characters in allowed url checks.
v1.3.15 - 2024-05-14
- ⚙️ Chore: Updated documentation
v1.3.14 - 2024-04-15
- ⚙️ Chore: Update dependencies
v1.3.13 - 2024-04-04
- ⚙️ Chore: Update dependencies
v1.3.12 - 2024-02-14
- ⚙️ Chore: Maintenance
v1.3.11 - 2024-02-14
- 🛡️ Security: Add more robust URL handling, do not allow '/../' in the URL, only allow GET and POST methods ( CVE-2023-5123 )
v1.3.10 - 2023-12-20
- ⚙️ Docs: Documentation website moved from github pages to grafana.com/docs/plugins page
v1.3.9 - 2023-11-21
- ⚙️ Chore: Update configuration page to follow best practices
- ⚙️ Chore: Remove legacy form styles
- ⚙️ Chore: Update readme and documentation
- ⚙️ Chore: Added lint github workflow
v1.3.8 - 2023-10-19
- ⚙️ Chore: Update dependencies
v1.3.7 - 2023-10-18
- ⚙️ Chore: Migrate to create-plugin
- ⚙️ Chore: Add feature tracking
v1.3.6 - 2023-05-30
- ⚙️ Chore: Docs update
v1.3.5 - 2023-04-05
- 🛡️ Security: Recently, A third party researcher (Alessio Della Libera of Snyk Research Team) discovered and privately disclosed to us a stored XSS vulnerability in the Grafana-maintained
marcusolsson-json-datasource
plugin also known as “JSON API plugin” .
Users with the editor role could perform a stored XSS attack against other viewers, editors, and administrators by including a specially crafted javascript statement in the field
extractor in queries to the marcusolsson-json-datasource plugin. This resulted in XSS against anyone viewing a panel configured to query the datasource with a malicious query.
This vulnerability worked because the marcusolsson-json-datasource
plugin uses the jsonpath-plus
library to evaluate editor-supplied jsonpath expressions. In its default configuration (which we used), this library is an XSS vector, as the JSONPath spec allows for embedded subexpressions, which jsonpath-plus
implements as arbitrary javascript expressions.
In order to mitigate this vulnerability, we now supply a configuration parameter to jsonpath-plus
which forbids the evaluation of subexpressions; it is important to note that this change may break existing JSONPath queries that rely on filter or eval expressions.
If your dashboards currently rely on JSONPath queries containing subexpressions, there are a few potential migration paths:
- For simple queries that use subexpressions for indexing/slicing, it may be possible to rewrite the query without a subexpressions for instance
[(@.length-1)]
can also be represented as[:-1]
. - For more complex queries, we suggest switching to the
jsonata
language, which the plugin also supports. This language has similar features to JSONPath, including support for filter expressions (called “predicates” in the documentation). - If changing your existing queries isn’t feasible, the community plugin “Infinity” supports JSONPath expressions, including filters and subexpressions if used with the
backend
parser option. Please note that Infinity is community supported plugin.
v1.3.4 - 2023-04-04
- ⚙️ Chore: docs update
v1.3.3 - 2023-03-20
- ⚙️ Chore: dependencies update
- ⚙️ Chore: spellcheck added
v1.3.2 - 2022-10-14
- Fixed the broken docs and links
v1.3.1 - 2022-01-24
Enhancements
- Append suffix to param key to uniquify duplicate param keys #232 (thanks @rejohnst!)
- Added grafana global variables when doing a query using jsonata #223 (thanks @amng!)
Bug fixes
- Certain strings incorrectly identified as dates #202
v1.3.0 - 2021-09-03
Enhancements
- Add support for JSONata (#114), a query language similar to JSONPath with support for transformations.
Bug fixes
- Cannot read property 'filter' of undefined (#156)
v1.2.1 - 2021-06-18
Enhancements
- Update dependencies, docs, and metadata
v1.2.0 - 2021-05-18
Enhancements
- Adding $isoFrom() and $isoTo() macros (#115) (thanks @jirkafajfr!)
- Using JSON.stringify instead of toString for object types in parseValue (#111) (thanks @Totalus!)
Bug fixes
- 🐛 Fix: Fix for macros not running in variable queries (#100) (thanks @KensingtonTech!)
v1.1.1 - 2021-04-17
Enhancements
- Improve editor styling
Bug fixes
- 🐛 Fix: Fix issue where wrong fields were used when grouping
- Add variable support for aliases
v1.1.0 - 2021-04-15
This release introduces an Experimental tab to the query editor. This will be used to let users try out features while they're being developed. Each feature has a link the the GitHub issue where you can share you feedback, before the feature is considered stable.
Enhancements
- Extend variables support to options
- Don't detect time fields from Unix epoch (#82)
- Add params to cache key (#85)
- Add support for field aliases
- Add Experimental section to query editor to test features under development
- Experimental: Group query results by field (#36)
- Experimental: Set display name for metric fields (#36)
- Experimental: Set optional label for variables (#79)
Bug fixes
- Ignore hidden queries (#83)
- New queries don't use default values
v1.0.1 - 2021-03-05
Enhancements
- Add annotation support
Bug fixes
- Can't connect to API when URL contains encoded slash (#59)
v1.0.0 - 2021-03-04
No noteworthy features or bug fixes in this release. Mostly metadata updates.
v0.10.1 - 2021-02-27
Bug fixes
- Undefined cache duration isn't handled
- Query editor tries to update read only property
v0.10.0 - 2021-02-19
Enhancements
- Add auto-completion to JSON Path queries
v0.9.2 - 2021-02-03
Bug fixes
- Variable queries fail with error (#48)
v0.9.1 - 2021-02-01
Bug fixes
- Cannot read property 'toString' of null (#46)
v0.9.0 - 2021-02-01
BREAKING CHANGE: Query parameters set by the query editor no longer overrides the data source config, to match how headers are handled in the Grafana proxy. This establishes the convention that any configuration made by an administrator should have higher priority.
IMPORTANT: This release contains many new changes that touches several aspects of the plugin. Make sure that you back up your dashboards before updating your plugin.
This release introduces a new query editor that gives more control of the request.
- Support for both GET and POST methods
- Support for request bodies (when using POST)
- Support for headers
It introduces a new key value editor for query parameters and headers, as well as a Monaco-based editor for editing the request body with syntax highlighting.
This release deprecates the queryString
property in the query model, in favor of the new params
. The query string config should be backwards-compatible (and forward-compatible) with previous versions, but make sure to back up your dashboard before upgrading.
v0.8.0 - 2021-01-08
Enhancements
- Use the refId as the series name
- Add type configuration for queries (#37)
Bug fixes
- Grafana Explore gets stuck when adding a second query (#31)
- Multiple data source queries overwrite each other
v0.7.1 - 2020-12-07
Bug fixes
- Falsy values are returned as NaN (#25)
v0.7.0 - 2020-12-04
Enhancements
- Add support for custom paths (#24)
- Add epoch time macros (#22)
- Migrate to new form components. This bumps the minimum required Grafana version to 7.3.0
Bug fixes
v0.6.4 - 2020-11-30
Bug fixes
- Fixes an issue where custom query parameters defined in the data source are flipped.
v0.6.3 - 2020-11-27
Enhancements
- Updated
@grafana
dependencies from^7.0.0
to^7.3.0
- Improved release process using the new GitHub workflows for Grafana plugins