174 lines
3.6 KiB
Markdown
174 lines
3.6 KiB
Markdown
---
|
|
aliases:
|
|
- ../../../http_api/dashboard_versions/ # /docs/grafana/next/http_api/dashboard_versions/
|
|
- ../../../http_api/dashboardversions/ # /docs/grafana/next/http_api/dashboardversions/
|
|
- ../../../developers/http_api/dashboard_versions/ # /docs/grafana/next/developers/http_api/dashboard_versions/
|
|
canonical: https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/dashboard_versions/
|
|
description: Grafana Dashboard Versions HTTP API
|
|
keywords:
|
|
- grafana
|
|
- http
|
|
- documentation
|
|
- api
|
|
- dashboard
|
|
- versions
|
|
labels:
|
|
products:
|
|
- enterprise
|
|
- oss
|
|
- cloud
|
|
title: 'Dashboard Versions HTTP API '
|
|
---
|
|
|
|
# Dashboard Versions
|
|
|
|
## Get all dashboard versions by dashboard UID
|
|
|
|
Query parameters:
|
|
|
|
- **limit** - Maximum number of results to return. Defaults to 1000 if not set, or if an invalid value is passed in.
|
|
- **start** - Version to start from when returning queries
|
|
|
|
`GET /api/dashboards/uid/:uid/versions`
|
|
|
|
Gets all existing dashboard versions for the dashboard with the given `uid`.
|
|
|
|
**Example request for getting all dashboard versions**:
|
|
|
|
```http
|
|
GET /api/dashboards/uid/QA7wKklGz/versions?limit=2?start=0 HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
```
|
|
|
|
**Example Response**
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 428
|
|
|
|
```
|
|
|
|
Status Codes:
|
|
|
|
- **200** - Ok
|
|
- **400** - Errors
|
|
- **401** - Unauthorized
|
|
- **404** - Dashboard version not found
|
|
|
|
## Get dashboard version by dashboard UID
|
|
|
|
`GET /api/dashboards/uid/:uid/versions/:version`
|
|
|
|
Get the dashboard version with the given version, for the dashboard with the given UID.
|
|
|
|
**Example request for getting a dashboard version**:
|
|
|
|
```http
|
|
GET /api/dashboards/uid/QA7wKklGz/versions/1 HTTP/1.1
|
|
Accept: application/json
|
|
Content-Type: application/json
|
|
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
|
```
|
|
|
|
**Example response**:
|
|
|
|
```http
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/json; charset=UTF-8
|
|
Content-Length: 1300
|
|
|
|
```
|
|
|
|
Status Codes:
|
|
|
|
- **200** - Ok
|
|
- **401** - Unauthorized
|
|
- **404** - Dashboard version not found
|