正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

エラートラッキングAPI

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、プロジェクトのError Tracking機能とやり取りします。詳細については、Error Trackingを参照してください。

前提要件:

  • メンテナーロール以上が必要です。

Error Tracking設定を取得します

指定されたプロジェクトのError Tracking設定を取得します。

GET /projects/:id/error_tracking/settings
属性型必須説明
id整数はいプロジェクトの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
}

Error Tracking設定を作成します

指定されたプロジェクトのError Tracking設定を作成します。

このAPIは、integrated error trackingで使用する場合にのみ使用できます。

PUT /projects/:id/error_tracking/settings

サポートされている属性は以下のとおりです:

属性型必須説明
id整数はいプロジェクトのIDまたはURLエンコードされたパス。
activeブール値はいtrueを渡してError Tracking設定構成を有効にするか、falseを渡して無効にします。
integratedブール値はいtrueを渡して、統合されたError Trackingバックエンドを有効にします。

リクエスト例:

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
}

Error Trackingプロジェクト設定を有効化します

指定されたプロジェクトのError Tracking設定をアクティブ化または非アクティブ化します。

PATCH /projects/:id/error_tracking/settings
属性型必須説明
id整数はいプロジェクトのIDまたはURLエンコードされたパス。
activeブール値はいtrueを渡して、すでに構成されているError Tracking設定を有効にするか、falseを渡して無効にします。
integratedブール値いいえtrueを渡して、統合されたError Trackingバックエンドを有効にします。
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
}

すべてのプロジェクトクライアントキーを一覧表示します

指定されたプロジェクトのすべてのintegrated error trackingクライアントキーをリストします。

GET /projects/:id/error_tracking/client_keys
属性型必須説明
id整数または文字列はいプロジェクトの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"
  }
]

クライアントキーを作成します

指定されたプロジェクトのintegrated error trackingクライアントキーを作成します。公開キーの属性は自動的に生成されます。

POST /projects/:id/error_tracking/client_keys
属性型必須説明
id整数または文字列はいプロジェクトの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"
}

クライアントキーを削除します

指定されたプロジェクトからintegrated error trackingクライアントキーを削除します。

DELETE /projects/:id/error_tracking/client_keys/:key_id
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス。
key_id整数はいクライアントキーのID。
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/error_tracking/client_keys/13"