Документацияbreadcrumb arrow Grafanabreadcrumb arrow Документация GlaberGraphbreadcrumb arrow Ресурсы для разработчиковbreadcrumb arrow API Grafanabreadcrumb arrow Справочное руководство по HTTP API Grafanabreadcrumb arrow Устаревший HTTP API Grafanabreadcrumb arrow API поиска по папкам и дашбордам

API поиска по папкам и дашбордам

Note

Starting in Grafana 13, /api endpoints are being deprecated in favor of the /apis route. Note that while Grafana is working on migrating existing APIs, currently there may not be an exact match to the legacy API you’re using.

This change doesn’t disrupt or break your current setup. Legacy APIs are not being disabled and remain fully accessible and operative, but /api routes will no longer be updated.

To learn more refer to the new API structure in Grafana.

Поиск папок и дашбордов

GET /api/search/

Примечание: при использовании управления доступом на основе ролей результаты поиска будут содержать только те дашборды и папки, к которым у вас есть доступ.

Параметры запроса:

  • query – поисковый запрос
  • tag – список тегов для поиска
  • type – тип для поиска, dash-folder или dash-db
  • dashboardIds – список ID дашбордов для поиска
  • dashboardUID – список uid дашбордов для поиска. Устарел начиная с Grafana v9.1, вместо него используйте dashboardUIDs
  • dashboardUIDs – список uid дашбордов для поиска
  • folderUIDs – список UID папок для поиска в них
  • starred – флаг, указывающий, возвращать ли только дашборды, добавленные в избранное
  • limit – ограничение числа возвращаемых результатов (максимум 5000; по умолчанию 1000). Если указано недопустимое значение (например, строки или специальные символы), параметр принимает значение по умолчанию 1000.
  • page – используйте этот параметр для доступа к результатам за пределами limit. Нумерация начинается с 1. Параметр limit действует как размер страницы.

Пример запроса на получение папок и дашбордов на корневом уровне:

http 
GET /api/search?query=&starred=false HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Пример ответа на получение папок и дашбордов на корневом уровне:

http 
HTTP/1.1 200
Content-Type: application/json

[
  {
    "id": 163,
    "uid": "000000163",
    "orgId": 1,
    "title": "Folder",
    "url": "/dashboards/f/000000163/folder",
    "type": "dash-folder",
    "tags": [],
    "isStarred": false,
    "uri":"db/folder" // deprecated in Grafana v5.0
  },
  {
    "id":1,
    "uid": "cIBgcSjkk",
    "orgId": 1,
    "title":"Production Overview",
    "url": "/d/cIBgcSjkk/production-overview",
    "type":"dash-db",
    "tags":[prod],
    "isStarred":true,
    "uri":"db/production-overview" // deprecated in Grafana v5.0
  }
]

Пример запроса на поиск дашбордов:

http 
GET /api/search?query=Production%20Overview&starred=true&tag=prod HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVICE_ACCOUNT_TOKEN>

Пример ответа на поиск дашбордов:

http 
HTTP/1.1 200
Content-Type: application/json

[
  {
    "id":1,
    "uid": "cIBgcSjkk",
    "orgId": 1,
    "title":"Production Overview",
    "url": "/d/cIBgcSjkk/production-overview",
    "type":"dash-db",
    "tags":[prod],
    "isStarred":true,
    "folderId": 2,
    "folderUid": "000000163",
    "folderTitle": "Folder",
    "folderUrl": "/dashboards/f/000000163/folder",
    "uri":"db/production-overview" // deprecated in Grafana v5.0
  }
]