This is documentation for the next version of Grafana documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow Developer resourcesbreadcrumb arrow Grafana APIsbreadcrumb arrow HTTP API
Enterprise Open source Grafana Cloud

Grafana HTTP API reference guide

Every Grafana instance exposes an HTTP API, used by the Grafana frontend to manage resources like saving dashboards, creating users, updating data sources, deleting alerts, and more. You can use the HTTP API to programmatically access or manage resources from your Grafana instance.

If you need to manage or access other resources from your Grafana Cloud Stack, refer to the Grafana Cloud API instead.

New generation HTTP APIs

Grafana is deprecating legacy APIs (/api) in favor of a new generation of improved APIs (/apis) which follow a standardized API structure alongside consistent API versioning.

To learn more refer to:

The Grafana API specification

Grafana HTTP APIs comply both with the OpenAPI v2 specification (Swagger 2.0) and OpenAPI v3 specification. While both describe the exact same set of Grafana HTTP API routes (dashboards, folders, data sources, organizations, users, teams, RBAC, alerting provisioning…), v2 is the canonical specification and source of truth, and v3 is converted from the v2 file using a conversion script.

If you’re consuming a Grafana HTTP API:

  • Use v2 if your tooling (SDK generators, older Swagger UI, terraform-provider-grafana) expects Swagger 2.0.
  • Use v3 if your tooling requires OpenAPI 3.x (for example, newer codegen tools, some API gateways, Postman’s newer import features).

You can browse and try out both via the Swagger UI editor, served by the Grafana server, by navigating to /swagger-ui.

Authentication

In OSS, you can authenticate your requests to the HTTP APIs using basic auth or a service account token. In Grafana Cloud, only the service account token option is available. For more details refer to HTTP API authentication.

List of available HTTP APIs

The following table lists all available HTTP API reference pages. New APIs are listed first, followed by legacy APIs.

APITypeReplaces legacy API
Alert enrichment HTTP API (Swagger)NewNo
Alert notifications HTTP API (Swagger)NewNo
Banners HTTP API (Swagger)NewNo
Dashboard HTTP APINew/api/dashboards/*
Folder HTTP APINew/api/folders/*
SLO (Swagger)New - Cloud onlyNo
Playlist HTTP APINewNo
Resource history HTTP APINewNo
Secrets Management HTTP APINewNo
Stars HTTP APINew/api/collection/*
Admin HTTP APIDeprecatedNot Applicable
Alerting Provisioning HTTP APIDeprecatedNot Applicable
Annotations HTTP APIDeprecatedNot Applicable
Correlations HTTP APIDeprecatedNot Applicable
Dashboard Permissions HTTP APIDeprecatedNot Applicable
Dashboard Versions HTTP APIDeprecatedNot Applicable
Data source HTTP APIDeprecatedNot Applicable
Data source LBAC rules HTTP APIDeprecatedNot Applicable
Data source permissions HTTP APIDeprecatedNot Applicable
Folder/Dashboard Search HTTP APIDeprecatedNot Applicable
Folder Permissions HTTP APIDeprecatedNot Applicable
Library Element HTTP APIDeprecatedNot Applicable
Licensing HTTP APIDeprecatedNot Applicable
Organization HTTP APIDeprecatedNot Applicable
Other HTTP APIDeprecatedNot Applicable
Preferences APIDeprecatedNot Applicable
Query and Resource Caching HTTP APIDeprecatedNot Applicable
Query History HTTP APIDeprecatedNot Applicable
RBAC HTTP APIDeprecatedNot Applicable
Reporting APIDeprecatedNot Applicable
Service account HTTP APIDeprecatedNot Applicable
Shared Dashboards HTTP APIDeprecatedNot Applicable
Short URL HTTP APIDeprecatedNot Applicable
Snapshot APIDeprecatedNot Applicable
SSO Settings APIDeprecatedNot Applicable
Stars API - /user/stars/*DeprecatedNot Applicable
Team HTTP APIDeprecatedNot Applicable
Team Sync HTTP APIDeprecatedNot Applicable
User HTTP APIDeprecatedNot Applicable

Use the following resources to keep working with Grafana APIs: