# Dashboard annotations API > 原文：[https://docs.gitlab.com/ee/api/metrics_dashboard_annotations.html](https://docs.gitlab.com/ee/api/metrics_dashboard_annotations.html) * [Create a new annotation](#create-a-new-annotation) # Dashboard annotations API[](#dashboard-annotations-api "Permalink") 版本歷史 * 在 GitLab 12.10 中在禁用的功能標志后面[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29089) . 指標儀表板注釋使您可以在單個時間點或整個時間段內指示圖形上的事件. ## Create a new annotation[](#create-a-new-annotation "Permalink") ``` POST /environments/:id/metrics_dashboard/annotations/ POST /clusters/:id/metrics_dashboard/annotations/ ``` **注意：** `dashboard_path`的值將被視為 CGI 轉義的路徑，并自動取消轉義. Parameters: | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `dashboard_path` | string | yes | 需要注釋的儀表盤的 ID. | | `starting_at` | string | yes | 日期時間字符串，ISO 8601 格式，例如`2016-03-11T03:45:40Z` . 注釋的時間戳標記起點. | | `ending_at` | string | no | 日期時間字符串，ISO 8601 格式，例如`2016-03-11T03:45:40Z` . 注釋的時間戳標記終點. 如果未提供，注釋將在起點顯示為單個事件. | | `description` | string | yes | 注釋的描述. | ``` curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/environments/1/metrics_dashboard/annotations" \ --data-urlencode "dashboard_path=.gitlab/dashboards/custom_metrics.yml" \ --data-urlencode "starting_at=2016-03-11T03:45:40Z" \ --data-urlencode "description=annotation description" ``` 示例響應： ``` { "id": 4, "starting_at": "2016-04-08T03:45:40.000Z", "ending_at": null, "dashboard_path": ".gitlab/dashboards/custom_metrics.yml", "description": "annotation description", "environment_id": 1, "cluster_id": null } ```