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
  4. [
  5.   {
  6.     "id": 163,
  7.     "uid": "000000163",
  8.     "title": "Folder",
  9.     "url": "/dashboards/f/000000163/folder",
  10.     "type": "dash-folder",
  11.     "tags": [],
  12.     "isStarred": false,
  13.     "uri":"db/folder" // deprecated in Grafana v5.0
  14.   },
  15.   {
  16.     "id":1,
  17.     "uid": "cIBgcSjkk",
  18.     "title":"Production Overview",
  19.     "url": "/d/cIBgcSjkk/production-overview",
  20.     "type":"dash-db",
  21.     "tags":[prod],
  22.     "isStarred":true,
  23.     "uri":"db/production-overview" // deprecated in Grafana v5.0
  24.   }
  25. ]

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
  4. [
  5.   {
  6.     "id":1,
  7.     "uid": "cIBgcSjkk",
  8.     "title":"Production Overview",
  9.     "url": "/d/cIBgcSjkk/production-overview",
  10.     "type":"dash-db",
  11.     "tags":[prod],
  12.     "isStarred":true,
  13.     "folderId": 2,
  14.     "folderUid": "000000163",
  15.     "folderTitle": "Folder",
  16.     "folderUrl": "/dashboards/f/000000163/folder",
  17.     "uri":"db/production-overview" // deprecated in Grafana v5.0
  18.   }
  19. ]