Folder/Dashboard Search API
Search folders and dashboards
GET /api/search/
Note: When using Role-based access control, search results will contain only dashboards and folders which you have access to.
Query parameters:
- query – Search Query
- tag – List of tags to search for
- type – Type to search for,
dash-folder
ordash-db
- dashboardIds – List of dashboard id’s to search for
- dashboardUID - List of dashboard uid’s to search for, It is deprecated since Grafana v9.1, please use dashboardUIDs instead
- dashboardUIDs – List of dashboard uid’s to search for
- folderUIDs – List of folder UIDs to search in
- starred – Flag indicating if only starred Dashboards should be returned
- limit – Limit the number of returned results (max is 5000; default is 1000)
- page – Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size.
Example request for retrieving folders and dashboards at the root level:
GET /api/search?query=&starred=false HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Example response for retrieving folders and dashboards at the root level:
Example request searching for dashboards:
GET /api/search?query=Production%20Overview&starred=true&tag=prod HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
Example response searching for dashboards: