폴더/대시보드 검색 API

이 문서는 Grafana에서 폴더와 대시보드를 검색하는 API를 설명해요. 검색 쿼리, 태그, 유형, ID, 즐겨찾기 등 다양한 필터를 사용할 수 있습니다.

출처: 문서

본문

참고: Grafana 13부터 /api 엔드포인트는 /apis 경로를 위해 더 이상 사용되지 않습니다(deprecated). Grafana가 기존 API를 마이그레이션하는 동안 현재 여러분이 사용하는 레거시 API와 정확히 일치하는 항목이 없을 수도 있어요. 이 변경은 현재 설정을 방해하거나 깨지 않습니다. 레거시 API는 비활성화되지 않으며 완전히 접근 가능하고 정상 작동하지만, /api 경로는 더 이상 업데이트되지 않습니다. 자세한 내용은 Grafana의 새 API 구조를 참고하세요.

폴더와 대시보드 검색하기

GET /api/search/

참고: 역할 기반 접근 제어(RBAC)를 사용할 때 검색 결과에는 접근 권한이 있는 대시보드와 폴더만 포함됩니다.

쿼리 파라미터:

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 파라미터가 페이지 크기 역할을 합니다.

루트 레벨에서 폴더와 대시보드 검색 예시 요청

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

루트 레벨에서 폴더와 대시보드 검색 예시 응답

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
  }
]

대시보드 검색 예시 요청

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

대시보드 검색 예시 응답

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
  }
]

더 알아보기 (Learn more)

원문 문서