Jack Baldry
4cacab01f4
* Use relative aliases for all non-current Grafana aliases Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove all current page aliases find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/latest/[^\n]*\n#\n#' {} \; find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \; Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
102 lines
2.5 KiB
Markdown
102 lines
2.5 KiB
Markdown
---
|
||
description: Grafana Folder/Dashboard Search HTTP API
|
||
keywords:
|
||
- grafana
|
||
- http
|
||
- documentation
|
||
- api
|
||
- search
|
||
- folder
|
||
- dashboard
|
||
title: 'Folder/Dashboard Search HTTP API '
|
||
---
|
||
|
||
# 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**:
|
||
|
||
```http
|
||
GET /api/search?folderIds=0&query=&starred=false HTTP/1.1
|
||
Accept: application/json
|
||
Content-Type: application/json
|
||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||
```
|
||
|
||
**Example response for retrieving folders and dashboards of the general folder**:
|
||
|
||
```http
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
```
|
||
|
||
**Example request searching for dashboards**:
|
||
|
||
```http
|
||
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**:
|
||
|
||
```http
|
||
HTTP/1.1 200
|
||
Content-Type: application/json
|
||
|
||
```
|