v1

latestOpenAPI 3.0.32026-07-14314472448.6 KB
search

get/search

Query parameters

querystring

Search Query

tagstring[]

List of tags to search for

type'dash-folder' | 'dash-db'

Type to search for, dash-folder or dash-db

dashboardIdsinteger[]

List of dashboard id’s to search for This is deprecated: users should use the dashboardUIDs query parameter instead

dashboardUIDsstring[]

List of dashboard uid’s to search for

folderIdsinteger[]

List of folder id’s to search in for dashboards If it's 0 then it will query for the top level folders This is deprecated: users should use the folderUIDs query parameter instead

folderUIDsstring[]

List of folder UID’s to search in for dashboards If it's an empty string then it will query for the top level folders

starredboolean

Flag indicating if only starred Dashboards should be returned

limitinteger

Limit the number of returned results (max 5000)

pageinteger

Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+.

permission'Edit' | 'View'

Set to Edit to return dashboards/folders that the user can edit

sort'alpha-asc' | 'alpha-desc'

Sort method; for listing all the possible sort methods use the search sorting endpoint.

deletedboolean

Flag indicating if only soft deleted Dashboards should be returned

Response

(empty)

descriptionstring
folderIdinteger
folderTitlestring
folderUidstring
folderUrlstring
idinteger
isDeletedboolean
isStarredboolean
orgIdinteger
permanentlyDeleteDatestring date-time
slugstring
sortMetainteger
sortMetaNamestring
tagsstring[]
titlestring
typestring
uidstring
uristring
urlstring