---
title: "HTTP API | Grafana Cloud documentation"
description: "Grafana HTTP API"
---

> For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt).

# 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](https://grafana.com/docs/grafana-cloud/account-management/cloud-stacks/), refer to the [Grafana Cloud API](https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/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 new [API structure in Grafana](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/) for information on the new HTTP API structure.
- The [API migration guide](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis-migration/) for details on the legacy API deprecation process.

## The Grafana API specification

Grafana HTTP APIs comply both with the [OpenAPI v2 specification (Swagger 2.0)](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgrafana%2Fgrafana%2Fmain%2Fpublic%2Fapi-merged.json) and [OpenAPI v3 specification](https://editor.swagger.io/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgrafana%2Fgrafana%2Fmain%2Fpublic%2Fopenapi3.json). 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`.

## 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](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/authentication/).

## List of available HTTP APIs

The following table lists all available HTTP APIs that comply with the new structure:

Expand table

| API                                                                                                                                                                                                                 | Availability              | Replaces legacy API                                                                                                                                                                         |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Advisor HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/advisor/)                                                                                      | All editions              | No                                                                                                                                                                                          |
| [Alert enrichment HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/alert-enrichment/)                                                                    | Cloud only                | No                                                                                                                                                                                          |
| [Alert notifications HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/alert-notifications/)                                                              | All editions              | This API partially replaces [`/api/v1/provisioning/*`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/alerting_provisioning/) |
| [Alert rules HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/alert-rules/)                                                                              | All editions              | This API partially replaces [`/api/v1/provisioning/*`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/alerting_provisioning/) |
| [Annotations HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/annotations/)                                                                              | All editions              | [`/api/annotations/*`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/annotations/)                                           |
| [Banners HTTP API (Swagger)](https://play.grafana.org/swagger?api=banners.grafana.app-v0alpha1)                                                                                                                     | All editions              | No                                                                                                                                                                                          |
| [Collections HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/stars/) (currently offers stars)                                                           | All editions              | [`/api/user/stars/*`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/user/#star-a-dashboard)                                  |
| [Dashboard HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/dashboard/) (also serves library panels, snapshots, search, notebooks, and global variables) | All editions              | `/api/dashboards/*`                                                                                                                                                                         |
| [Folder HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/folder/)                                                                                        | All editions              | `/api/folders/*`                                                                                                                                                                            |
| [Notebooks HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/notebooks/)                                                                                  | All editions              | No                                                                                                                                                                                          |
| [SLO (Swagger) / Kubernetes CRD](https://play.grafana.org/swagger?api=grafana-slo-app.plugins.grafana.com-v1)                                                                                                       | Cloud only                | No                                                                                                                                                                                          |
| [Playlist HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/playlist/)                                                                                    | All editions              | No                                                                                                                                                                                          |
| [Preferences HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/)                                                                              | All editions              | [`/api/*/preferences`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/preferences/)                                           |
| [Queries HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/queries/)                                                                                      | Enterprise and Cloud only | This API partially replaces [`/api/query-history/*`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/query_history/)           |
| [Resource history HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/resource-history/)                                                                    | All editions              | [`/api/dashboards/uid/:uid/versions/*`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/dashboard_versions/)                   |
| [SCIM HTTP API (Swagger)](https://play.grafana.org/swagger?api=scim.grafana.app-v0alpha1)                                                                                                                           | Enterprise and Cloud only | No                                                                                                                                                                                          |
| [Secrets Management HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/secrets_management/)                                                                | Enterprise and Cloud only | No                                                                                                                                                                                          |
| [Short URL HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/short_url/)                                                                                  | All editions              | [`/api/short-urls/*`](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/short_url/)                                              |

### Legacy APIs

The following table lists legacy APIs and their replacements, if any:

Expand table

| API                                                                                                                                                                             | Replaced by                                                                                                                                                                                                                                                                                                                      |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Admin HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/admin/)                                           | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Alerting Provisioning HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/alerting_provisioning/)           | The [Alert rules HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/alert-rules/) and [Alert notifications HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/alert-notifications/) partially replace this API |
| [Annotations HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/annotations/)                               | [Annotations HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/annotations/)                                                                                                                                                                                           |
| [Correlations HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/correlations/)                             | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Dashboard Permissions HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/dashboard_permissions/)           | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Dashboard Versions HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/dashboard_versions/)                 | [Resource history HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/resource-history/)                                                                                                                                                                                 |
| [Data source HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/data_source/)                               | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Data source LBAC rules HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/datasource_lbac_rules/)          | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Data source permissions HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/datasource_permissions/)        | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Folder/Dashboard Search HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/folder_dashboard_search/)       | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Folder Permissions HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/folder_permissions/)                 | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Library Element HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/library_element/)                       | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Licensing HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/licensing/)                                   | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Organization HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/org/)                                      | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Other HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/other/)                                           | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Preferences API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/preferences/)                                    | [Preferences HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/preferences/)                                                                                                                                                                                           |
| [Query and Resource Caching HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/query_and_resource_caching/) | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Query History HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/query_history/)                           | The [Queries HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/queries/) partially replaces this API                                                                                                                                                                   |
| [RBAC HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/access_control/)                                   | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Reporting API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/reporting/)                                        | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Service account HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/serviceaccount/)                        | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Shared Dashboards HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/dashboard_public/)                    | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Short URL HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/short_url/)                                   | [Short URL HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/short_url/)                                                                                                                                                                                               |
| [Snapshot API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/snapshot/)                                          | Not available yet                                                                                                                                                                                                                                                                                                                |
| [SSO Settings API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/sso-settings/)                                  | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Stars HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/user/#star-a-dashboard)                           | [Collections HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/stars/)                                                                                                                                                                                                 |
| [Team HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/team/)                                             | Not available yet                                                                                                                                                                                                                                                                                                                |
| [Team Sync HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/team_sync/)                                   | Not available yet                                                                                                                                                                                                                                                                                                                |
| [User HTTP API](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/api-legacy/user/)                                             | Not available yet                                                                                                                                                                                                                                                                                                                |

## Related resources

Use the following resources to keep working with Grafana APIs:

- **API structure:** Refer to [The new API structure in Grafana](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis/).
- **Migration guide:** Refer to [Migrate to the new APIs](https://grafana.com/docs/grafana-cloud/learn-and-build/developer-resources/api-reference/http-api/apis-migration/).
- **Swagger UI:** Open the `/swagger` page in your Grafana instance to inspect endpoint schemas and try requests.
