错误跟踪设置 API

引入于 12.7 版本。

错误跟踪项目设置

项目设置 API 允许您为一个项目设置检索错误跟踪。仅适用于具备项目维护者权限的用户。

获取错误跟踪设置 

GET /projects/:id/error_tracking/settings
参数 类型 是否必需 描述
id integer yes ID 或者项目 URL 路径（由经过身份验证的用户拥有） 
curl --header "PRIVATE-TOKEN: <your_access_token>" "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
}

启用或禁用错误跟踪项目设置

API 允许您为一个项目启用或禁用错误追踪设置。仅适用于具备项目维护者权限的用户。 

PATCH /projects/:id/error_tracking/settings
参数 类型 是否必需 描述
id integer yes ID 或者项目 URL 路径（由经过身份验证的用户拥有）。
active boolean yes 通过 true 来启用已配置的错误追踪设置或者通过 false 禁用。
integrated boolean no 通过 true 来启用已配置的错误追踪后端，可用于 14.2 及以上版本。 
curl --header "PRIVATE-TOKEN: <your_access_token>" "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
}

客户端密钥错误追踪

引入于 14.3 版本。

集成错误追踪功能。仅适用于具备项目维护者权限的用户。

列出项目客户端密钥 

GET /projects/:id/error_tracking/client_keys
参数 类型 是否必需 描述
id integer/string yes ID 或者项目 URL 路径（由经过身份验证的用户拥有） 
curl --header "PRIVATE-TOKEN: <your_access_token>" "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@gitlab.example.com/api/v4/error_tracking/collector/5"
  },
  {
    "id": 3,
    "active": true,
    "public_key": "glet_0ff98b1d849c083f76d0bc545ed053a3",
    "sentry_dsn": "https://glet_0ff98b1d849c083f76d0bc545ed053a3@gitlab.example.com/api/v4/error_tracking/collector/5"
  }
]

创建一个客户端密钥

为项目创建一个新的客户端密钥。公钥参数自动生成。 

POST /projects/:id/error_tracking/client_keys
参数 类型 是否必需 描述
id integer/string yes ID 或者项目 URL 路径（由经过身份验证的用户拥有） 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys"

示例： 

{
  "id": 3,
  "active": true,
  "public_key": "glet_0ff98b1d849c083f76d0bc545ed053a3",
  "sentry_dsn": "https://glet_0ff98b1d849c083f76d0bc545ed053a3@gitlab.example.com/api/v4/error_tracking/collector/5"
}

删除一个客户端密钥

从项目中移除一个客户端密钥。 

DELETE /projects/:id/error_tracking/client_keys/:key_id
参数 类型 是否必需 描述
id integer/string yes ID 或者项目 URL 路径（由经过身份验证的用户拥有）
key_id integer yes 客户端密钥 ID 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys/13"