Dashboard Permissions API
This API can be used to update/get the permissions for a dashboard.
Permissions with dashboardId=-1
are the default permissions for users with the Viewer and Editor roles. Permissions can be set for a user, a team or a role (Viewer or Editor). Permissions cannot be set for Admins - they always have access to everything.
The permission levels for the permission field:
- 1 = View
- 2 = Edit
- 4 = Admin
If you are running Grafana Enterprise, for some endpoints you’ll need to have specific permissions. Refer to Role-based access control permissions for more information.
Get permissions for a dashboard
GET /api/dashboards/uid/:uid/permissions
Gets all existing permissions for the dashboard with the given uid
.
Required permissions
See note in the introduction for an explanation.
Action | Scope |
---|---|
dashboards.permissions:read |
dashboards:uid:* folders:uid:* |
Example request:
GET /api/dashboards/uid/dHEquNzGz/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Example Response
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": "dHEquNzGz",
"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": "dHEquNzGz",
"title": "",
"slug": "",
"isFolder": false,
"url": ""
}
]
Status Codes:
- 200 - Ok
- 401 - Unauthorized
- 403 - Access denied
- 404 - Dashboard not found
Update permissions for a dashboard
POST /api/dashboards/uid/:uid/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 for an explanation.
Action | Scope |
---|---|
dashboards.permissions:write |
dashboards:uid:* folders:uid:* |
Example request:
POST /api/dashboards/uid/dHEquNzGz/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/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
Get permissions for a dashboard by id
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 /api/dashboards/id/:dashboardId/permissions
Gets all existing permissions for the dashboard with the given dashboardId
.
Required permissions
See note in the introduction for an explanation.
Action | Scope |
---|---|
dashboards.permissions:read |
dashboards:* folders:* |
Example request:
GET /api/dashboards/id/1/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Example Response
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
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.
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 for an explanation.
Action | Scope |
---|---|
dashboards.permissions:write |
dashboards:* folders:* |
Example request:
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/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
Related Grafana resources
Opening keynote: What's new in Grafana 9?
Raj Dutt, Myrle Krantz, and Torkel Ödegaard unveil what's new in Grafana 9. Watch the opening keynote presentation from GrafanaCONline 2022. On-demand.
Unify your data with Grafana plugins: Splunk, MongoDB, Datadog, and more
Show how Grafana can be used to take data from multiple different sources and unify it, without disrupting the investments that are working today.
Getting started with Grafana Enterprise and observability
Join the Grafana Labs team for a 30-minute demo of how to get started with the Grafana Stack, so you can go from zero to observability in just a few minutes.