エラートラッキングAPI

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

このAPIを使用して、プロジェクトのエラートラッキング機能と対話します。詳細については、エラートラッキングを参照してください。

前提条件:

メンテナーまたはオーナーのロールを持っている必要があります。

エラートラッキング設定を取得する

指定されたプロジェクトのエラートラッキング設定を取得する。

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
}

エラートラッキング設定を作成

指定されたプロジェクトのエラートラッキング設定を作成します。

このAPIは、統合エラートラッキングと組み合わせて使用する場合にのみ利用可能です。

PUT /projects/:id/error_tracking/settings

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

属性	型	必須	説明
`id`	整数	はい	プロジェクトのIDまたはURLエンコードされたパス。
`active`	ブール値	はい	`true`を渡してエラートラッキング設定の構成を有効にするか、`false`を渡して無効にします。
`integrated`	ブール値	はい	`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`	整数	はい	プロジェクトのIDまたはURLエンコードされたパス。
`active`	ブール値	はい	`true`を渡してすでに構成されているエラートラッキング設定を有効にするか、`false`を渡して無効にします。
`integrated`	ブール値	いいえ	`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`	整数または文字列	はい	プロジェクトの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`	整数または文字列	はい	プロジェクトの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`	整数または文字列	はい	プロジェクトの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"