오류 추적 API
Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
요약
이 API를 사용하여 프로젝트의 오류 추적 기능과 상호 작용합니다. 지정된 프로젝트의 오류 추적 설정을 조회합니다. 지정된 프로젝트의 오류 추적 설정을 만듭니다. 이 API는 통합 오류 추적과 함께 사용할 때만 사용 가능합니다.
이 API를 사용하여 프로젝트의 오류 추적 기능과 상호 작용합니다. 자세한 내용은 오류 추적을 참조하세요.
필수 요건:
- Maintainer 또는 Owner 역할이 있어야 합니다.
오류 추적 설정 조회#
지정된 프로젝트의 오류 추적 설정을 조회합니다.
GET /projects/:id/error_tracking/settings
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 | yes | 프로젝트의 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
}
오류 추적 설정 만들기#
히스토리
- GitLab 15.10에서 도입됨.
지정된 프로젝트의 오류 추적 설정을 만듭니다.
Note
이 API는 통합 오류 추적과 함께 사용할 때만 사용 가능합니다.
PUT /projects/:id/error_tracking/settings
지원되는 속성:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
active |
불리언 | yes | 오류 추적 설정 구성을 활성화하려면 true, 비활성화하려면 false를 전달합니다. |
integrated |
불리언 | yes | 통합 오류 추적 백엔드를 활성화하려면 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
}
오류 추적 프로젝트 설정 업데이트#
지정된 프로젝트의 오류 추적 설정을 업데이트합니다.
PATCH /projects/:id/error_tracking/settings
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
active |
불리언 | yes | 이미 구성된 오류 추적 설정을 활성화하려면 true, 비활성화하려면 false를 전달합니다. |
integrated |
불리언 | no | 통합 오류 추적 백엔드를 활성화하려면 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 |
정수 또는 문자열 | yes | 프로젝트의 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 |
정수 또는 문자열 | yes | 프로젝트의 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 |
정수 또는 문자열 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
key_id |
정수 | yes | 클라이언트 키의 ID. |
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys/13"