{{< details >}}
- Tier: 基础版,专业版,旗舰版
- Offering: JihuLab.com,私有化部署
{{< /details >}}
错误追踪项目设置
项目设置 API 允许您检索项目的 错误追踪 设置。仅适用于项目的维护者角色用户。
获取错误追踪设置
GET /projects/:id/error_tracking/settings
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer | 是 | 项目的 ID 或 URL 编码路径 |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings"
示例响应:
{
"active": true,
"project_name": "sample sentry project",
"sentry_external_url": "https://sentry.io/myawesomeproject/project",
"api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
"integrated": false
}
创建错误追踪设置
{{< history >}}
- 引入于极狐GitLab 15.10。
{{< /history >}}
该 API 允许您为项目创建错误追踪设置。仅适用于项目的维护者角色用户。
{{< alert type=”note” >}}
此 API 仅在使用 集成错误追踪 时可用。
{{< /alert >}}
PUT /projects/:id/error_tracking/settings
支持的属性:
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer | 是 | 项目的 ID 或 URL 编码路径。 |
active |
boolean | 是 | 传递 true 以启用错误追踪设置配置或传递 false 以禁用它。 |
integrated |
boolean | 是 | 传递 true 以启用集成错误追踪后端。 |
示例请求:
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true&integrated=true"
示例响应:
{
"active": true,
"project_name": null,
"sentry_external_url": null,
"api_url": null,
"integrated": true
}
启用或禁用错误追踪项目设置
该 API 允许您启用或禁用项目的错误追踪设置。仅适用于项目的维护者角色用户。
PATCH /projects/:id/error_tracking/settings
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer | 是 | 项目的 ID 或 URL 编码路径。 |
active |
boolean | 是 | 传递 true 以启用已配置的错误追踪设置或传递 false 以禁用它。 |
integrated |
boolean | 否 | 传递 true 以启用集成错误追踪后端。 |
curl --request PATCH --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true"
示例响应:
{
"active": true,
"project_name": "sample sentry project",
"sentry_external_url": "https://sentry.io/myawesomeproject/project",
"api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
"integrated": false
}
错误追踪客户端密钥
适用于 集成错误追踪 功能。仅适用于项目的维护者角色用户。
列出项目客户端密钥
GET /projects/:id/error_tracking/client_keys
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer/string | 是 | 项目的 ID 或 URL 编码路径。 |
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys"
示例响应:
[
{
"id": 1,
"active": true,
"public_key": "glet_aa77551d849c083f76d0bc545ed053a3",
"sentry_dsn": "https://glet_aa77551d849c083f76d0bc545ed053a3@example.com/errortracking/api/v1/projects/5"
},
{
"id": 3,
"active": true,
"public_key": "glet_0ff98b1d849c083f76d0bc545ed053a3",
"sentry_dsn": "https://glet_aa77551d849c083f76d0bc545ed053a3@example.com/errortracking/api/v1/projects/5"
}
]
创建客户端密钥
为项目创建新的客户端密钥。公共密钥属性自动生成。
POST /projects/:id/error_tracking/client_keys
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer/string | 是 | 项目的 ID 或 URL 编码路径。 |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header "Content-Type: application/json" \
--url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys"
示例响应:
{
"id": 3,
"active": true,
"public_key": "glet_0ff98b1d849c083f76d0bc545ed053a3",
"sentry_dsn": "https://glet_aa77551d849c083f76d0bc545ed053a3@example.com/errortracking/api/v1/projects/5"
}
删除客户端密钥
从项目中移除客户端密钥。
DELETE /projects/:id/error_tracking/client_keys/:key_id
属性 | 类型 | 必需 | 描述 |
---|---|---|---|
id |
integer/string | 是 | 项目的 ID 或 URL 编码路径。 |
key_id |
integer | 是 | 客户端密钥的 ID。 |
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys/13"