NFnforgeio
search

GET /search

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/search
  • Auth
    • HTTP basic
    • or API key in header Authorization

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

dashboardUIDsstring[]

List of dashboard uid’s to search for

folderIdsinteger[]

List of folder id’s to search in for dashboards

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.

Response

(empty)

folderIdinteger
folderTitlestring
folderUidstring
folderUrlstring
idinteger
isStarredboolean
slugstring
sortMetainteger
sortMetaNamestring
tagsstring[]
titlestring
typestring
uidstring
uristring
urlstring

Changes

No recorded changes to this operation across all 2 revisions of this API.