Folder/Dashboard Search API

Search folders and dashboards

GET /api/search/

Query parameters:

  • query – Search Query
  • tag – List of tags to search for
  • type – Type to search for, dash-folder or dash-db
  • dashboardIds – List of dashboard id’s to search for
  • folderIds – List of folder id’s to search in for dashboards
  • 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. Only available in Grafana v6.2+.

Example request for retrieving folders and dashboards of the general folder:

  1. GET /api/search?folderIds=0&query=&starred=false HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example response for retrieving folders and dashboards of the general folder:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  3. [
  4. {
  5. "id": 163,
  6. "uid": "000000163",
  7. "title": "Folder",
  8. "url": "/dashboards/f/000000163/folder",
  9. "type": "dash-folder",
  10. "tags": [],
  11. "isStarred": false,
  12. "uri":"db/folder" // deprecated in Grafana v5.0
  13. },
  14. {
  15. "id":1,
  16. "uid": "cIBgcSjkk",
  17. "title":"Production Overview",
  18. "url": "/d/cIBgcSjkk/production-overview",
  19. "type":"dash-db",
  20. "tags":[prod],
  21. "isStarred":true,
  22. "uri":"db/production-overview" // deprecated in Grafana v5.0
  23. }
  24. ]

Example request searching for dashboards:

  1. GET /api/search?query=Production%20Overview&starred=true&tag=prod HTTP/1.1
  2. Accept: application/json
  3. Content-Type: application/json
  4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Example response searching for dashboards:

  1. HTTP/1.1 200
  2. Content-Type: application/json
  3. [
  4. {
  5. "id":1,
  6. "uid": "cIBgcSjkk",
  7. "title":"Production Overview",
  8. "url": "/d/cIBgcSjkk/production-overview",
  9. "type":"dash-db",
  10. "tags":[prod],
  11. "isStarred":true,
  12. "folderId": 2,
  13. "folderUid": "000000163",
  14. "folderTitle": "Folder",
  15. "folderUrl": "/dashboards/f/000000163/folder",
  16. "uri":"db/production-overview" // deprecated in Grafana v5.0
  17. }
  18. ]