diff --git a/docs/sources/developers/http_api/dashboard_permissions.md b/docs/sources/developers/http_api/dashboard_permissions.md index 5f2844be2cb..07242307875 100644 --- a/docs/sources/developers/http_api/dashboard_permissions.md +++ b/docs/sources/developers/http_api/dashboard_permissions.md @@ -183,161 +183,3 @@ Status Codes: - **401** - Unauthorized - **403** - Access denied - **404** - Dashboard not found - -## Get permissions for a dashboard by id - -{{% admonition type="warning" %}} -This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new dashboard permissions API](#get-permissions-for-a-dashboard). -{{% /admonition %}} - -`GET /api/dashboards/id/:dashboardId/permissions` - -Gets all existing permissions for the dashboard with the given `dashboardId`. - -**Required permissions** - -See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. - - -| Action | Scope | -| ----------------------------- | ------------------------------------------------------------------------------------------------------- | -| `dashboards.permissions:read` | | -{ .no-spacing-list } - - -**Example request**: - -```http -GET /api/dashboards/id/1/permissions 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: 551 - -[ - { - "id": 1, - "dashboardId": -1, - "created": "2017-06-20T02:00:00+02:00", - "updated": "2017-06-20T02:00:00+02:00", - "userId": 0, - "userLogin": "", - "userEmail": "", - "teamId": 0, - "team": "", - "role": "Viewer", - "permission": 1, - "permissionName": "View", - "uid": "", - "title": "", - "slug": "", - "isFolder": false, - "url": "" - }, - { - "id": 2, - "dashboardId": -1, - "created": "2017-06-20T02:00:00+02:00", - "updated": "2017-06-20T02:00:00+02:00", - "userId": 0, - "userLogin": "", - "userEmail": "", - "teamId": 0, - "team": "", - "role": "Editor", - "permission": 2, - "permissionName": "Edit", - "uid": "", - "title": "", - "slug": "", - "isFolder": false, - "url": "" - } -] -``` - -Status Codes: - -- **200** - Ok -- **401** - Unauthorized -- **403** - Access denied -- **404** - Dashboard not found - -## Update permissions for a dashboard by id - -{{% admonition type="warning" %}} -This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new dashboard permissions API](#update-permissions-for-a-dashboard). -{{% /admonition %}} - -`POST /api/dashboards/id/:dashboardId/permissions` - -Updates permissions for a dashboard. This operation will remove existing permissions if they're not included in the request. - -**Required permissions** - -See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. - - -| Action | Scope | -| ------------------------------ | ------------------------------------------------------------------------------------------------------- | -| `dashboards.permissions:write` | | -{ .no-spacing-list } - - -**Example request**: - -```http -POST /api/dashboards/id/1/permissions -Accept: application/json -Content-Type: application/json -Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk - -{ - "items": [ - { - "role": "Viewer", - "permission": 1 - }, - { - "role": "Editor", - "permission": 2 - }, - { - "teamId": 1, - "permission": 1 - }, - { - "userId": 11, - "permission": 4 - } - ] -} -``` - -JSON body schema: - -- **items** - The permission items to add/update. Items that are omitted from the list will be removed. - -**Example response**: - -```http -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 -Content-Length: 35 - -{"message":"Dashboard permissions updated"} -``` - -Status Codes: - -- **200** - Ok -- **401** - Unauthorized -- **403** - Access denied -- **404** - Dashboard not found diff --git a/docs/sources/developers/http_api/dashboard_versions.md b/docs/sources/developers/http_api/dashboard_versions.md index fc98f7fe5e8..96960701098 100644 --- a/docs/sources/developers/http_api/dashboard_versions.md +++ b/docs/sources/developers/http_api/dashboard_versions.md @@ -20,68 +20,6 @@ title: 'Dashboard Versions HTTP API ' # Dashboard Versions -## Get all dashboard versions - -{{% admonition type="warning" %}} -This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new dashboard versions API](#get-all-dashboard-versions-by-dashboard-uid). -{{% /admonition %}} - -Query parameters: - -- **limit** - Maximum number of results to return -- **start** - Version to start from when returning queries - -`GET /api/dashboards/id/:dashboardId/versions` - -Gets all existing dashboard versions for the dashboard with the given `dashboardId`. - -**Example request for getting all dashboard versions**: - -```http -GET /api/dashboards/id/1/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 - -[ - { - "id": 2, - "dashboardId": 1, - "parentVersion": 1, - "restoredFrom": 0, - "version": 2, - "created": "2017-06-08T17:24:33-04:00", - "createdBy": "admin", - "message": "Updated panel title" - }, - { - "id": 1, - "dashboardId": 1, - "parentVersion": 0, - "restoredFrom": 0, - "version": 1, - "created": "2017-06-08T17:23:33-04:00", - "createdBy": "admin", - "message": "Initial save" - } -] -``` - -Status Codes: - -- **200** - Ok -- **400** - Errors -- **401** - Unauthorized -- **404** - Dashboard version not found - ## Get all dashboard versions by dashboard UID Query parameters: @@ -142,96 +80,6 @@ Status Codes: - **401** - Unauthorized - **404** - Dashboard version not found -## Get dashboard version - -{{% admonition type="warning" %}} -This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new get dashboard version API](#get-dashboard-version-by-dashboard-uid). -{{% /admonition %}} - -`GET /api/dashboards/id/:dashboardId/versions/:version` - -Get the dashboard version with the given version, for the dashboard with the given id. - -**Example request for getting a dashboard version**: - -```http -GET /api/dashboards/id/1/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 - -{ - "id": 1, - "dashboardId": 1, - "parentVersion": 0, - "restoredFrom": 0, - "version": 1, - "created": "2017-04-26T17:18:38-04:00", - "message": "Initial save", - "data": { - "annotations": { - "list": [ - - ] - }, - "editable": true, - "gnetId": null, - "graphTooltip": 0, - "id": 1, - "links": [ - - ], - "rows": [ - { - "collapse": false, - "height": "250px", - "panels": [ - - ], - "repeat": null, - "repeatIteration": null, - "repeatRowId": null, - "showTitle": false, - "title": "Dashboard Row", - "titleSize": "h6" - } - ], - "schemaVersion": 14, - "tags": [ - - ], - "templating": { - "list": [ - - ] - }, - "time": { - "from": "now-6h", - "to": "now" - }, - "timepicker": {}, - "timezone": "browser", - "title": "test", - "version": 1 - }, - "createdBy": "admin" -} -``` - -Status Codes: - -- **200** - Ok -- **401** - Unauthorized -- **404** - Dashboard version not found - ## Get dashboard version by dashboard UID `GET /api/dashboards/uid/:uid/versions/:version` @@ -319,76 +167,6 @@ Status Codes: - **401** - Unauthorized - **404** - Dashboard version not found -## Restore dashboard - -{{% admonition type="warning" %}} -This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new restore dashboard API](#restore-dashboard-by-dashboard-uid). -{{% /admonition %}} - -`POST /api/dashboards/id/:dashboardId/restore` - -Restores a dashboard to a given dashboard version. - -**Example request for restoring a dashboard version**: - -```http -POST /api/dashboards/id/1/restore -Accept: application/json -Content-Type: application/json -Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk - -{ - "version": 1 -} -``` - -JSON body schema: - -- **version** - The dashboard version to restore to - -**Example response**: - -```http -HTTP/1.1 200 OK -Content-Type: application/json; charset=UTF-8 -Content-Length: 67 - -{ - "slug": "my-dashboard", - "status": "success", - "version": 3 -} -``` - -JSON response body schema: - -- **slug** - the URL friendly slug of the dashboard's title -- **status** - whether the restoration was successful or not -- **version** - the new dashboard version, following the restoration - -Status codes: - -- **200** - OK -- **401** - Unauthorized -- **404** - Not found (dashboard not found or dashboard version not found) -- **500** - Internal server error (indicates issue retrieving dashboard tags from database) - -**Example error response** - -```http -HTTP/1.1 404 Not Found -Content-Type: application/json; charset=UTF-8 -Content-Length: 46 - -{ - "message": "Dashboard version not found" -} -``` - -JSON response body schema: - -- **message** - Message explaining the reason for the request failure. - ## Restore dashboard by dashboard UID `POST /api/dashboards/uid/:uid/restore`