realaravinth/debian-mirror-gitlab
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
debian-mirror-gitlab/doc/api/metrics_user_starred_dashboards.md
Pirate Praveen 44f8ec8b25 New upstream version 13.0.0
2020-05-24 23:13:21 +05:30

2.1 KiB
Raw Blame History

User-starred metrics dashboards API

The starred dashboard feature makes navigating to frequently-used dashboards easier by displaying favorited dashboards at the top of the select list.

Add a star to a dashboard

POST /projects/:id/metrics/user_starred_dashboards

Parameters:

Attribute Type Required Description
dashboard_path string yes URL-encoded path to file defining the dashboard which should be marked as favorite. 
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"

Example Response:

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

Remove a star from a dashboard

DELETE /projects/:id/metrics/user_starred_dashboards

Parameters:

Attribute Type Required Description
dashboard_path string no URL-encoded path to file defining the dashboard which should no longer be marked as favorite. When not supplied all dashboards within given projects will be removed from favorites. 
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"

Example Response:

{
  "deleted_rows": 1
}