Error Tracking 설정 API

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

Error Tracking 프로젝트 설정

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

에러 추적 설정 가져오기 

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": "샘플 센트리 프로젝트",
  "sentry_external_url": "https://sentry.io/myawesomeproject/project",
  "api_url": "https://sentry.io/api/0/projects/myawesomeproject/project",
  "integrated": false
}

에러 추적 설정 생성

이 API를 사용하면 프로젝트의 에러 추적 설정을 생성할 수 있습니다. 프로젝트에 대한 Maintainer 역할을 하는 사용자만 가능합니다.

참고: 이 API는 통합 에러 추적과 함께 사용할 때에만 사용할 수 있습니다. 

PUT /projects/:id/error_tracking/settings

지원되는 속성:

속성 유형 필수여부 설명
id integer yes 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
active boolean yes true를 전달하여 에러 추적 설정 구성을 활성화하거나 false를 전달하여 비활성화합니다.
integrated boolean yes true를 전달하여 통합된 에러 추적 백엔드를 활성화합니다. GitLab 14.2 및 이후 버전에서 사용 가능합니다.

요청 예시: 

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 yes 인증된 사용자가 소유한 프로젝트의 ID 또는 URL 인코딩된 경로
active boolean yes 구성된 에러 추적 설정을 활성화하려면 true를 전달하거나 비활성화하려면 false를 전달합니다.
integrated boolean no true를 전달하여 통합된 에러 추적 백엔드를 활성화합니다. GitLab 14.2 및 이후 버전에서 사용 가능합니다. 
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 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@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"