mirror of
https://github.com/grafana/grafana.git
synced 2024-11-30 12:44:10 -06:00
100 lines
2.6 KiB
Markdown
100 lines
2.6 KiB
Markdown
+++
|
||
title = "Folder/Dashboard Search HTTP API "
|
||
description = "Grafana Folder/Dashboard Search HTTP API"
|
||
keywords = ["grafana", "http", "documentation", "api", "search", "folder", "dashboard"]
|
||
aliases = ["/docs/grafana/latest/http_api/folder_dashboard_search/"]
|
||
type = "docs"
|
||
[menu.docs]
|
||
name = "Folder/dashboard search"
|
||
parent = "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 5000)
|
||
- **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
|
||
|
||
```
|