diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-14 15:08:21 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-14 15:08:21 +0300 |
commit | 674e7e2c3d295704bdf504dd0caa2e5a2d9b5cd2 (patch) | |
tree | 7454890d4f7aa8644c9e89954a978466e4416815 /doc/api/metrics_user_starred_dashboards.md | |
parent | c7ad2610df033b370845995ac3bbe269a191d9bb (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/metrics_user_starred_dashboards.md')
-rw-r--r-- | doc/api/metrics_user_starred_dashboards.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/api/metrics_user_starred_dashboards.md b/doc/api/metrics_user_starred_dashboards.md index 94bc1d3b4d1..dd9144d1319 100644 --- a/doc/api/metrics_user_starred_dashboards.md +++ b/doc/api/metrics_user_starred_dashboards.md @@ -32,3 +32,30 @@ Example Response: "project_id": 20 } ``` + +## Remove a star from a dashboard + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31892) in GitLab 13.0. + +```plaintext +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. | + +```shell +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: + +```json +{ + "deleted_rows": 1 +} +``` |