Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation Developers HTTP API

HTTP API reference

The Grafana backend exposes an HTTP API, which is the same API that is used by the frontend to do everything from saving dashboards, creating users, and updating data sources.

Since version 8.4, HTTP API details are specified using OpenAPI v2.

Starting from version 9.1, there is also a OpenAPI v3 specification (generated by the v2 one).

Users can browser and try out both via the Swagger UI editor (served by the grafana server) by navigating to /swagger-ui and /openapi3 respectively.

HTTP APIs

• Admin API
• Alerting API (unstable)
• Alerting Provisioning API
• Annotations API
• Authentication API
• Correlations API
• Dashboard API
• Dashboard Permissions API
• Dashboard Versions API
• Data source API
• Folder API
• Folder Permissions API
• Folder/Dashboard Search API
• Library Element API
• Organization API
• Other API
• Playlists API
• Preferences API
• Short URL API
• Query history API
• Snapshot API
• Team API
• User API

Deprecated HTTP APIs

• Alerting Notification Channels API
• Alerting API

Grafana Enterprise HTTP APIs

Grafana Enterprise includes all of the Grafana OSS APIs as well as those that follow:

• Role-based access control API
• Data source permissions API
• Team sync API
• License API
• Reporting API