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

Enterprise Open source Grafana Cloud

Migrate to the new Grafana APIs

Note

New APIs are available in Grafana 12 and later. Legacy APIs are deprecated starting in Grafana 13.

Grafana is migrating existing APIs to the new /apis model, a Kubernetes-style API layer which follows a standardized API structure alongside consistent API versioning. Refer to the New API structure in Grafana documentation for more details.

Legacy APIs are not being disabled for the moment. Removal of legacy APIs is planned for a future major release, and any breaking changes will be announced well in advance to avoid disruptions.

Deprecation notes

The API migration process is underway and there may not be an exact /apis match to the legacy API you’re using. Some legacy APIs may not be migrated at all. For details, refer to List of available HTTP APIs table.

Alerting Provisioning API

The Alerting Provisioning HTTP API is partially replaced by two /apis groups:

The file-provisioning export endpoints (/api/v1/provisioning/*/export) and receiver permission endpoints (/api/access-control/receivers/*) don’t have /apis equivalents yet and remain on the legacy API.

Query history API

The Query History API is partially replaced by the Queries HTTP API, which is only available in Grafana Enterprise and Grafana Cloud. If you use the Query History API to keep queries on the server, you can save them as saved queries instead. To learn how the endpoints match, refer to Differences from the legacy Query history API.

The rest of the query history functionality is being deprecated. Grafana will revert to using local on-device storage for query history, since this approach reduces the amount of traffic to the backend with minimal change in functionality. If you’re using this API to record query history, consider using a similar approach.