오류 추적 설정 API

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

오류 추적 프로젝트 설정

프로젝트 설정 API를 사용하면 프로젝트의 오류 추적 설정을 검색할 수 있습니다. 프로젝트에 대한 Maintainer 역할을 가진 사용자만 사용할 수 있습니다.

오류 추적 설정 가져오기 

GET /projects/:id/error_tracking/settings
속성 유형 필수 여부 설명
id integer 예 프로젝트의 ID 또는 URL 인코딩된 경로 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings"

예제 응답:

{
  "active": true,
  "project_name": "샘플 센트리 프로젝트",
  "sentry_external_url": "https://sentry.io/myawesomeproject/project",
  "api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
  "integrated": false
}

오류 추적 설정 만들기

API를 사용하여 프로젝트의 오류 추적 설정을 생성할 수 있습니다. 프로젝트에 대한 Maintainer 역할을 가진 사용자만 사용할 수 있습니다.

note
이 API는 통합 오류 추적과 함께 사용할 때만 사용할 수 있습니다.
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>" "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를 사용하면 프로젝트의 오류 추적 설정을 활성화 또는 비활성화할 수 있습니다. 프로젝트에 대한 Maintainer 역할을 가진 사용자만 사용할 수 있습니다.

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>" "https://gitlab.example.com/api/v4/projects/1/error_tracking/settings?active=true"

예제 응답:

{
  "active": true,
  "project_name": "샘플 센트리 프로젝트",
  "sentry_external_url": "https://sentry.io/myawesomeproject/project",
  "api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
  "integrated": false
}

오류 추적 클라이언트 키

통합 오류 추적 기능을 위한 것입니다. 프로젝트의 Maintainer 역할을 가진 사용자만 사용할 수 있습니다.

프로젝트 클라이언트 키 목록 

GET /projects/:id/error_tracking/client_keys
속성 유형 필수 설명
id integer/string 예 프로젝트의 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@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" \
     "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>" "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys/13"