Folder Permissions API
This API can be used to update/get the permissions for a folder.
Permissions with folderId=-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 folder
GET /api/folders/:uid/permissions
Gets all existing permissions for the folder with the given uid
.
Required permissions
See note in the introduction for an explanation.
Example request:
GET /api/folders/nErXDvCkzz/permissions HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Example Response
Status Codes:
- 200 - Ok
- 401 - Unauthorized
- 403 - Access denied
- 404 - Folder not found
Update permissions for a folder
POST /api/folders/:uid/permissions
Updates permissions for a folder. This operation will remove existing permissions if they’re not included in the request.
Required permissions
See note in the introduction for an explanation.
Example request:
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":"Folder permissions updated","id":1,"title":"Department ABC"}
Status Codes:
- 200 - Ok
- 401 - Unauthorized
- 403 - Access denied
- 404 - Dashboard not found