사용자가 즐겨찾는 지표 대시보드 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

즐겨찾는 대시보드 기능은 자주 사용하는 대시보드로 이동을 쉽게 만들어줌으로써 즐겨찾는 대시보드를 선택 디렉터리 상단에 표시합니다.

대시보드에 별표 추가

History 
POST /projects/:id/metrics/user_starred_dashboards

파라미터:

속성 타입 필수 여부 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로
dashboard_path 문자열 예 즐겨찾는 대시보드로 표시할 대시보드를 정의하는 파일의 URL 인코딩된 경로 
curl --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards" \
 --data-urlencode "dashboard_path=config/prometheus/dashboards/common_metrics.yml"

예시 응답: 

{
  "id": 5,
  "dashboard_path": "config/prometheus/common_metrics.yml",
  "user_id": 1,
  "project_id": 20
}

대시보드에서 별표 제거

History 
DELETE /projects/:id/metrics/user_starred_dashboards

파라미터:

속성 타입 필수 여부 설명
id 정수/문자열 예 프로젝트의 ID 또는 URL 인코딩된 경로
dashboard_path 문자열 아니오 즐겨찾기에서 제거할 대시보드를 정의하는 파일의 URL 인코딩된 경로. 제공되지 않으면 지정된 프로젝트 내의 모든 대시보드가 즐겨찾는 항목에서 제거됩니다. 
curl --request DELETE --header 'Private-Token: <your_access_token>' "https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards" \
 --data-urlencode "dashboard_path=config/prometheus/dashboards/common_metrics.yml"

예시 응답: 

{
  "deleted_rows": 1
}