プロジェクトインテグレーションAPI
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
このAPIを使用して、プロジェクトのインテグレーションを管理します。
前提要件:
- プロジェクトのメンテナー以上のロールを持っている必要があります。
すべてのアクティブなインテグレーションをリスト表示
すべてのアクティブなプロジェクトインテグレーションのリストを取得します。vulnerability_eventsフィールドは、GitLab Enterprise Editionでのみ使用できます。
GET /projects/:id/integrationsレスポンス例:
[
{
"id": 75,
"title": "Jenkins CI",
"slug": "jenkins",
"created_at": "2019-11-20T11:20:25.297Z",
"updated_at": "2019-11-20T12:24:37.498Z",
"active": true,
"commit_events": true,
"push_events": true,
"issues_events": true,
"alert_events": true,
"confidential_issues_events": true,
"merge_requests_events": true,
"tag_push_events": false,
"deployment_events": false,
"note_events": true,
"confidential_note_events": true,
"pipeline_events": true,
"wiki_page_events": true,
"job_events": true,
"comment_on_event_enabled": true,
"inherited": false,
"vulnerability_events": true
},
{
"id": 76,
"title": "Alerts endpoint",
"slug": "alerts",
"created_at": "2019-11-20T11:20:25.297Z",
"updated_at": "2019-11-20T12:24:37.498Z",
"active": true,
"commit_events": true,
"push_events": true,
"issues_events": true,
"alert_events": true,
"confidential_issues_events": true,
"merge_requests_events": true,
"tag_push_events": true,
"deployment_events": false,
"note_events": true,
"confidential_note_events": true,
"pipeline_events": true,
"wiki_page_events": true,
"job_events": true,
"comment_on_event_enabled": true,
"inherited": false,
"vulnerability_events": true
}
]Apple App Store Connect
Apple App Store Connectを設定
プロジェクトのApple App Store Connectインテグレーションを設定します。
PUT /projects/:id/integrations/apple_app_storeパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
app_store_issuer_id | 文字列 | はい | Apple App Store Connect Issuer ID。 |
app_store_key_id | 文字列 | はい | Apple App Store ConnectキーID。 |
app_store_private_key_file_name | 文字列 | はい | Apple App Store Connectの秘密キーファイル名。 |
app_store_private_key | 文字列 | はい | Apple App Store Connectの秘密キー。 |
app_store_protected_refs | ブール値 | いいえ | 保護されたブランチとタグでのみ変数を設定します。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Apple App Store Connectを無効化
プロジェクトのApple App Store Connectインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/apple_app_storeApple App Store Connect設定を取得
プロジェクトのApple App Store Connectインテグレーション設定を取得します。
GET /projects/:id/integrations/apple_app_storeAsana
Asanaを設定
プロジェクトのAsanaインテグレーションを設定します。
PUT /projects/:id/integrations/asanaパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
api_key | 文字列 | はい | ユーザーAPIトークン。ユーザーはタスクにアクセスできる必要があります。すべてのコメントは、このユーザーに起因します。 |
restrict_to_branch | 文字列 | いいえ | 自動的に検査されるブランチのコンマ区切りリスト。すべてのブランチを含めるには、空白のままにします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Asanaを無効にする
プロジェクトのAsanaインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/asanaAsana設定を取得
プロジェクトのAsanaインテグレーション設定を取得します。
GET /projects/:id/integrations/asanaAssembla
Assemblaを設定
プロジェクトのAssemblaインテグレーションを設定します。
PUT /projects/:id/integrations/assemblaパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | 認証トークン。 |
subdomain | 文字列 | いいえ | サブドメイン設定。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Assemblaを無効にする
プロジェクトのAssemblaインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/assemblaAssembla設定を取得
プロジェクトのAssemblaインテグレーション設定を取得します。
GET /projects/:id/integrations/assemblaAtlassian Bamboo
Atlassian Bambooを設定
プロジェクトのAtlassian Bambooインテグレーションを設定します。
Bambooで自動リビジョンラベルとリポジトリトリガーを構成する必要があります。
PUT /projects/:id/integrations/bambooパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
bamboo_url | 文字列 | はい | BambooルートURL(例:https://bamboo.example.com)。 |
enable_ssl_verification | ブール値 | いいえ | SSL検証を有効にします。デフォルトはtrue(有効)です。 |
build_key | 文字列 | はい | Bambooビルドプランキー(例:KEY)。 |
username | 文字列 | はい | BambooサーバーへのAPIアクセスを持つユーザー。 |
password | 文字列 | はい | ユーザーのパスワード。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Atlassian Bambooを無効にする
プロジェクトのAtlassian Bambooインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/bambooAtlassian Bamboo設定を取得
プロジェクトのAtlassian Bambooインテグレーション設定を取得します。
GET /projects/:id/integrations/bambooBugzilla
Bugzillaを設定
プロジェクトのBugzillaインテグレーションを設定します。
PUT /projects/:id/integrations/bugzillaパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
new_issue_url | 文字列 | はい | 新しいイシューのURL。 |
issues_url | 文字列 | はい | イシューのURL。 |
project_url | 文字列 | はい | プロジェクトのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Bugzillaを無効にする
プロジェクトのBugzillaインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/bugzillaBugzilla設定を取得
プロジェクトのBugzillaインテグレーション設定を取得します。
GET /projects/:id/integrations/bugzillaBuildkite
Buildkiteを設定
プロジェクトのBuildkiteインテグレーションを設定します。
PUT /projects/:id/integrations/buildkiteパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | GitLabリポジトリでBuildkiteパイプラインを作成した後に取得するトークン。 |
project_url | 文字列 | はい | パイプラインのURL(例:https://buildkite.com/example/pipeline)。 |
enable_ssl_verification | ブール値 | いいえ | 非推奨: SSL検証は常に有効になっているため、このパラメータは無効です。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグプッシュイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Buildkiteを無効にする
プロジェクトのBuildkiteインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/buildkiteBuildkite設定を取得
プロジェクトのBuildkiteインテグレーション設定を取得します。
GET /projects/:id/integrations/buildkiteCampfire Classic
Campfire Classicとインテグレーションできます。ただし、Campfire Classicは、Basecampによって販売されなくなった古い製品です。
Campfire Classicを設定
プロジェクトのCampfire Classicインテグレーションを設定します。
PUT /projects/:id/integrations/campfireパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | Campfire ClassicからのAPI認証トークン。トークンを取得するには、Campfire Classicにサインインし、My info(個人情報)を選択します。 |
subdomain | 文字列 | いいえ | サインインしているときの.campfirenow.comサブドメイン。 |
room | 文字列 | いいえ | Campfire ClassicルームURLのID部分。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Campfire Classicを無効にする
プロジェクトのCampfire Classicインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/campfireCampfire Classic設定を取得
プロジェクトのCampfire Classicインテグレーション設定を取得します。
GET /projects/:id/integrations/campfireClickUp
ClickUpを設定
プロジェクトのClickUpインテグレーションを設定します。
PUT /projects/:id/integrations/clickupパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
issues_url | 文字列 | はい | イシューのURL。 |
project_url | 文字列 | はい | プロジェクトのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
ClickUpを無効にする
プロジェクトのClickUpインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/clickupClickUp設定を取得
プロジェクトのClickUpインテグレーション設定を取得します。
GET /projects/:id/integrations/clickupConfluenceワークスペース
プロジェクトのWikiとしてConfluence Cloudワークスペースを使用します。
Confluenceワークスペースを設定
プロジェクトのConfluenceワークスペースインテグレーションを設定します。
PUT /projects/:id/integrations/confluenceパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
confluence_url | 文字列 | はい | atlassian.netでホストされているConfluenceワークスペースのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Confluenceワークスペースを無効にする
プロジェクトのConfluenceワークスペースインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/confluenceConfluenceワークスペース設定を取得
プロジェクトのConfluenceワークスペースインテグレーション設定を取得します。
GET /projects/:id/integrations/confluenceカスタムイシュートラッカー
カスタムイシュートラッカーを設定
プロジェクトのカスタムイシュートラッカーを設定します。
PUT /projects/:id/integrations/custom-issue-trackerパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
new_issue_url | 文字列 | はい | 新しいイシューのURL。 |
issues_url | 文字列 | はい | イシューのURL。 |
project_url | 文字列 | はい | プロジェクトのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
カスタムイシュートラッカーを無効にする
プロジェクトのカスタムイシュートラッカーを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/custom-issue-trackerカスタムイシュートラッカー設定を取得
プロジェクトのカスタムイシュートラッカー設定を取得します。
GET /projects/:id/integrations/custom-issue-trackerDatadog
Datadogを設定
プロジェクトのDatadogインテグレーションを設定します。
PUT /projects/:id/integrations/datadogパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
api_key | 文字列 | はい | Datadogとの認証に使用されるAPIキー。 |
datadog_ci_visibility | ブール値 | はい | パイプライン実行トレーシングを表示するために、Datadogでパイプラインイベントとジョブイベントの収集を有効にします。 |
api_url | 文字列 | いいえ | Datadogサイトの完全なURL。 |
datadog_env | 文字列 | いいえ | セルフマネージドデプロイの場合、Datadogに送信されるすべてのデータのenv%タグ。 |
datadog_service | 文字列 | いいえ | Datadog内のすべてのデータをタグ付けするGitLabインスタンス。いくつかのセルフマネージドデプロイを管理する場合に使用できます。 |
datadog_site | 文字列 | いいえ | データの送信先となるDatadogサイト。EUサイトにデータを送信するには、datadoghq.euを使用します。 |
datadog_tags | 文字列 | いいえ | Datadogのカスタムタグ。形式key:value\nkey2:value2で、1行に1つのタグを指定します。 |
archive_trace_events | ブール値 | いいえ | 有効にすると、ジョブログがDatadogによって収集され、パイプライン実行トレーシングとともに表示されます(GitLab 15.3で導入)。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Datadogを無効にする
プロジェクトのDatadogインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/datadogDatadog設定を取得
プロジェクトのDatadogインテグレーション設定を取得します。
GET /projects/:id/integrations/datadogDiffblue Cover
Diffblue Coverを設定
プロジェクトのDiffblue Coverインテグレーションを設定します。
PUT /projects/:id/integrations/diffblue-coverパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
diffblue_license_key | 文字列 | はい | Diffblue Coverライセンスキー。 |
diffblue_access_token_name | 文字列 | はい | パイプラインでDiffblue Coverによって使用されるアクセストークン名。 |
diffblue_access_token_secret | 文字列 | はい | パイプラインでDiffblue Coverによって使用されるアクセストークンシークレット。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Diffblue Coverを無効にする
プロジェクトのDiffblue Coverインテグレーションを無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/diffblue-coverDiffblue Cover設定を取得
プロジェクトのDiffblue Coverインテグレーション設定を取得します。
GET /projects/:id/integrations/diffblue-coverDiscordの通知
Discordの通知を設定
プロジェクトのDiscord通知を設定します。
PUT /projects/:id/integrations/discordパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | Discord Webhook(例:https://discord.com/api/webhooks/...)。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、およびdefault_and_protectedです。デフォルト値はdefaultです。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
confidential_issue_channel | 文字列 | いいえ | 機密イシューイベントの通知を受信するWebhookのオーバーライド。 |
confidential_note_events | ブール値 | いいえ | 機密メモイベントの通知を有効にします。 |
confidential_note_channel | 文字列 | いいえ | 機密メモイベントの通知を受信するWebhookのオーバーライド。 |
deployment_events | ブール値 | いいえ | デプロイイベントの通知を有効にします。 |
deployment_channel | 文字列 | いいえ | デプロイイベントの通知を受信するWebhookのオーバーライド。 |
group_confidential_mentions_events | ブール値 | いいえ | グループの機密メンションイベントの通知を有効にします。 |
group_confidential_mentions_channel | 文字列 | いいえ | グループの機密メンションイベントの通知を受信するWebhookのオーバーライド。 |
group_mentions_events | ブール値 | いいえ | グループメンションイベントの通知を有効にします。 |
group_mentions_channel | 文字列 | いいえ | グループメンションイベントの通知を受信するWebhookのオーバーライド。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
issue_channel | 文字列 | いいえ | イシューイベントの通知を受信するWebhookのオーバーライド。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
merge_request_channel | 文字列 | いいえ | マージリクエストイベントの通知を受信するWebhookのオーバーライド。 |
note_events | ブール値 | いいえ | メモイベントの通知を有効にします。 |
note_channel | 文字列 | いいえ | メモイベントの通知を受信するWebhookのオーバーライド。 |
notify_only_broken_pipelines | ブール値 | いいえ | ブロックされたパイプラインの通知を送信します。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
pipeline_channel | 文字列 | いいえ | パイプラインイベントの通知を受信するWebhookのオーバーライド。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
push_channel | 文字列 | いいえ | プッシュイベントの通知を受信するWebhookのオーバーライド。 |
tag_push_events | ブール値 | いいえ | タグプッシュイベントの通知を有効にします。 |
tag_push_channel | 文字列 | いいえ | タグプッシュイベントの通知を受信するWebhookのオーバーライド。 |
wiki_page_events | ブール値 | いいえ | Wikiページイベントの通知を有効にします。 |
wiki_page_channel | 文字列 | いいえ | Wikiページイベントの通知を受信するWebhookのオーバーライド。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Discord通知を無効にする
プロジェクトのDiscord通知を無効にします。インテグレーション設定がリセットされました。
DELETE /projects/:id/integrations/discordDiscord通知設定を取得
プロジェクトのDiscord通知設定を取得します。
GET /projects/:id/integrations/discordDrone
Droneを設定
プロジェクトのDroneインテグレーションを設定します。
PUT /projects/:id/integrations/drone-ciパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | Drone CIトークン。 |
drone_url | 文字列 | はい | Drone CI URL(例:http://drone.example.com)。 |
enable_ssl_verification | ブール値 | いいえ | SSL認証を有効にします。デフォルトはtrue(有効)です。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Droneを無効にする
プロジェクトのDroneインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/drone-ciDrone設定を取得
プロジェクトのDroneインテグレーションの設定を取得します。
GET /projects/:id/integrations/drone-ciプッシュ時にメールを送信
プッシュ時にメールを送信
プロジェクトのプッシュ時にメールを送信インテグレーションをセットアップします。
PUT /projects/:id/integrations/emails-on-pushパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
recipients | 文字列 | はい | メールは空白で区切ります。 |
disable_diffs | ブール値 | いいえ | コードの差分を無効にします。 |
send_from_committer_email | ブール値 | いいえ | コミッターから送信。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、およびdefault_and_protectedです。通知は、タグ付けのプッシュで常にトリガーされます。デフォルト値はallです。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
プッシュ時にメールを送信を無効にする
プロジェクトのプッシュ時にメールを送信インテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/emails-on-pushプッシュ時にメールを送信設定を取得
プロジェクトのプッシュ時にメールを送信インテグレーションの設定を取得します。
GET /projects/:id/integrations/emails-on-pushEngineeringワークフローManagement(EWM)
EWMをセットアップ
プロジェクトのEWMインテグレーションをセットアップします。
PUT /projects/:id/integrations/ewmパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
new_issue_url | 文字列 | はい | 新しいイシューのURL。 |
project_url | 文字列 | はい | プロジェクトのURL。 |
issues_url | 文字列 | はい | イシューのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
EWMを無効にする
プロジェクトのEWMインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/ewmEWM設定を取得
プロジェクトのEWMインテグレーションの設定を取得します。
GET /projects/:id/integrations/ewm外部
外部Wikiをセットアップ
プロジェクトの外部Wikiをセットアップします。
PUT /projects/:id/integrations/external-wikiパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
external_wiki_url | 文字列 | はい | 外部WikiのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
外部Wikiを無効にする
プロジェクトの外部Wikiを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/external-wiki外部Wikiの設定を取得
プロジェクトの外部Wikiの設定を取得します。
GET /projects/:id/integrations/external-wikiGitGuardian
- プラン: Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
GitGuardianは、APIキーやパスワードなどの機密データをソースコードリポジトリで検出するサイバーセキュリティサービスです。Gitリポジトリをスキャンし、ポリシー違反についてアラートを送信し、ハッカーが悪用する前に組織がセキュリティを修正するのを支援します。
GitGuardianのポリシーに基づいてコミットを拒否するようにGitLabを構成できます。
既知の問題
- プッシュが遅延したり、タイムアウトしたりする可能性があります。GitGuardianインテグレーションでは、プッシュはサードパーティに送信され、GitLabはGitGuardianとの接続またはGitGuardianのプロセスを制御できません。
- GitGuardian API limitationにより、インテグレーションはサイズが1 MBを超えるファイルを無視します。それらはスキャンされません。
- プッシュされたファイルの名前が256文字を超える長さのプッシュは完了しません。詳細については、GitGuardian API documentationを参照してください。
integration pageのトラブルシューティングの手順は、これらの問題のいくつかを緩和する方法を示しています。
GitGuardianをセットアップ
プロジェクトのGitGuardianインテグレーションをセットアップします。
PUT /projects/:id/integrations/git-guardianパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | scanスコープを持つGitGuardian APIトークン。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
GitGuardianを無効にする
プロジェクトのGitGuardianインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/git-guardianGitGuardian設定を取得
プロジェクトのGitGuardianインテグレーションの設定を取得します。
GET /projects/:id/integrations/git-guardianGitHub
- プラン: Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated
GitHubをセットアップ
プロジェクトのGitHubインテグレーションをセットアップします。
PUT /projects/:id/integrations/githubパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | repo:status OAuth 2.0スコープを持つGitHub APIトークン。 |
repository_url | 文字列 | はい | GitHubリポジトリURL。 |
static_context | ブール値 | いいえ | ステータスチェック名に、GitLabインスタンスのホスト名を追加します。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
GitHubを無効にする
プロジェクトのGitHubインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/githubGitHub設定を取得
プロジェクトのGitHubインテグレーションの設定を取得します。
GET /projects/:id/integrations/githubGitLab for Jira Cloudアプリ
GitLab for Jira Cloudアプリインテグレーションは、Jiraでのグループリンクとリンク解除によって自動的に有効または無効になります。GitLab統合フォームまたはAPIを使用して統合を有効または無効にすることはできません。
プロジェクトのインテグレーションを更新する
このAPIエンドポイントを使用して、Jiraでグループのリンクを使用して作成するインテグレーションを更新します。
PUT /projects/:id/integrations/jira-cloud-appパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
jira_cloud_app_service_ids | 文字列 | いいえ | Jira Service ManagementサービスID。複数のIDを区切るには、コンマ(,)を使用します。 |
jira_cloud_app_enable_deployment_gating | ブール値 | いいえ | Jira Service ManagementからのブロックされたGitLabデプロイに対してデプロイゲーティングを有効にします。 |
jira_cloud_app_deployment_gating_environments | 文字列 | いいえ | デプロイゲーティングを有効にする環境(本番環境、ステージング、テスト、または開発)。デプロイゲーティングが有効になっている場合は必須です。複数の環境を区切るには、コンマ(,)を使用します。 |
Jira Cloudアプリの設定を取得
プロジェクトのJira Cloudアプリの統合設定を取得します。
GET /projects/:id/integrations/jira-cloud-appGitLab for Slackアプリ
GitLab for Slackアプリの設定
プロジェクトのSlackアプリの統合を更新します。
統合には、GitLab APIだけでは取得できないOAuth 2.0トークンが必要なため、APIを介してSlackアプリのGitLabを作成することはできません。代わりに、GitLab UIからアプリをインストールする必要があります。次に、このAPIエンドポイントを使用して統合を更新できます。
PUT /projects/:id/integrations/gitlab-slack-applicationパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
channel | 文字列 | いいえ | 他のチャンネルが構成されていない場合に使用するデフォルトのチャンネル。 |
notify_only_broken_pipelines | ブール値 | いいえ | 壊れたパイプラインの通知を送信します。 |
notify_only_default_branch | ブール値 | いいえ | 非推奨: このパラメータはbranches_to_be_notifiedに置き換えられました。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、およびdefault_and_protectedです。デフォルト値はdefaultです。 |
alert_events | ブール値 | いいえ | アラートイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | いいえ | 機密性の高いイシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密性の高いノートイベントの通知を有効にします。 |
deployment_events | ブール値 | いいえ | デプロイイベントの通知を有効にします。 |
incidents_events | ブール値 | いいえ | インシデントイベントの通知を有効にします。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
vulnerability_events | ブール値 | いいえ | 脆弱性イベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページイベントの通知を有効にします。 |
labels_to_be_notified | 文字列 | いいえ | 通知を送信するラベル。設定されていない場合は、すべてのイベントの通知を受信します。 |
labels_to_be_notified_behavior | 文字列 | いいえ | 通知されるラベル。有効なオプションは、match_anyとmatch_allです。match_anyがデフォルトです。 |
push_channel | 文字列 | いいえ | プッシュイベントの通知を受信するチャンネルの名前。 |
issue_channel | 文字列 | いいえ | イシューイベントの通知を受信するチャンネルの名前。 |
confidential_issue_channel | 文字列 | いいえ | 機密性の高いイシューイベントの通知を受信するチャンネルの名前。 |
merge_request_channel | 文字列 | いいえ | マージリクエストイベントの通知を受信するチャンネルの名前。 |
note_channel | 文字列 | いいえ | ノートイベントの通知を受信するチャンネルの名前。 |
confidential_note_channel | 文字列 | いいえ | 機密性の高いノートイベントの通知を受信するチャンネルの名前。 |
tag_push_channel | 文字列 | いいえ | タグ付けプッシュイベントの通知を受信するチャンネルの名前。 |
pipeline_channel | 文字列 | いいえ | パイプラインイベントの通知を受信するチャンネルの名前。 |
wiki_page_channel | 文字列 | いいえ | Wikiページイベントの通知を受信するチャンネルの名前。 |
deployment_channel | 文字列 | いいえ | デプロイイベントの通知を受信するチャンネルの名前。 |
incident_channel | 文字列 | いいえ | インシデントイベントの通知を受信するチャンネルの名前。 |
vulnerability_channel | 文字列 | いいえ | 脆弱性イベントの通知を受信するチャンネルの名前。 |
alert_channel | 文字列 | いいえ | アラートイベントの通知を受信するチャンネルの名前。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
GitLab for Slackアプリの場合:
プロジェクトのSlackアプリの統合を無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/gitlab-slack-applicationSlackアプリの設定を取得
プロジェクトのSlackアプリの統合設定を取得します。
GET /projects/:id/integrations/gitlab-slack-applicationGoogle Chat
Google Chatをセットアップ
プロジェクトのGoogle Chatインテグレーションをセットアップします。
PUT /projects/:id/integrations/hangouts-chatパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | HangoutsチャットWebhook(例:https://chat.googleapis.com/v1/spaces...)。 |
notify_only_broken_pipelines | ブール値 | いいえ | 壊れたパイプラインの通知を送信します。 |
notify_only_default_branch | ブール値 | いいえ | 非推奨: このパラメータはbranches_to_be_notifiedに置き換えられました。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、およびdefault_and_protectedです。デフォルト値はdefaultです。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | いいえ | 機密性の高いイシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密性の高いノートイベントの通知を有効にします。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Google Chatを無効にする
プロジェクトのGoogle Chatインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/hangouts-chatGoogle Chat設定を取得
プロジェクトのGoogle Chatインテグレーションの設定を取得します。
GET /projects/:id/integrations/hangouts-chatGoogle Artifact Management
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com
- ステータス: ベータ
この機能はベータ版です。
Google Artifact Managementを設定
プロジェクトのGoogle Artifact Management統合をセットアップします。
PUT /projects/:id/integrations/google-cloud-platform-artifact-registryパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
artifact_registry_project_id | 文字列 | はい | Google CloudプロジェクトのID。 |
artifact_registry_location | 文字列 | はい | Artifact Registryリポジトリの場所。 |
artifact_registry_repositories | 文字列 | はい | アーティファクトレジストリのリポジトリ。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Google Artifact Managementを無効にする
プロジェクトのGoogleアーティファクト管理インテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/google-cloud-platform-artifact-registryGoogleアーティファクト管理設定の取得
プロジェクトのGoogleアーティファクト管理インテグレーション設定を取得します。
GET /projects/:id/integrations/google-cloud-platform-artifact-registryGoogle Cloud Identity and Access Management(IAM)
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com
- ステータス: ベータ
この機能はベータ版です。
Google Cloud Identity and Access Managementのセットアップ
プロジェクトのGoogle Cloud Identity and Access Managementインテグレーションをセットアップします。
PUT /projects/:id/integrations/google-cloud-platform-workload-identity-federationパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workload_identity_federation_project_id | 文字列 | はい | ワークロードアイデンティティフェデレーションのGoogle CloudプロジェクトID。 |
workload_identity_federation_project_number | 整数 | はい | ワークロードアイデンティティフェデレーションのGoogle Cloudプロジェクト番号。 |
workload_identity_pool_id | 文字列 | はい | ワークロードIDプールのID。 |
workload_identity_pool_provider_id | 文字列 | はい | ワークロードIDプールプロバイダのID。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Google Cloud Identity and Access Managementを無効にする
プロジェクトのGoogle Cloud Identity and Access Managementインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/google-cloud-platform-workload-identity-federationGoogle Cloud Identity and Access Managementの取得
プロジェクトのGoogle Cloud Identity and Access Managementの設定を取得します。
GET /projects/:id/integration/google-cloud-platform-workload-identity-federationGoogle Play
Google Playを設定
プロジェクトのGoogle Playインテグレーションをセットアップします。
PUT /projects/:id/integrations/google-playパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
package_name | 文字列 | はい | Google Playでのアプリのパッケージ名。 |
service_account_key | 文字列 | はい | Google Playサービスアカウントキー。 |
service_account_key_file_name | 文字列 | はい | Google Playサービスアカウントキーのファイル名。 |
google_play_protected_refs | ブール値 | いいえ | 保護ブランチとタグでのみ、変数を設定します。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Google Playを無効にする
プロジェクトのGoogle Playインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/google-playGoogle Play設定を取得
プロジェクトのGoogle Playインテグレーション設定を取得します。
GET /projects/:id/integrations/google-playHarbor
Harborを設定
プロジェクトのHarborインテグレーションをセットアップします。
PUT /projects/:id/integrations/harborパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
url | 文字列 | はい | GitLabプロジェクトにリンクされているHarborインスタンスへのベースURL。たとえばhttps://demo.goharbor.ioなどです。 |
project_name | 文字列 | はい | Harborインスタンスでのプロジェクトの名前。たとえばtestprojectなどです。 |
username | 文字列 | はい | Harborインターフェースで作成されたユーザー名。 |
password | 文字列 | はい | ユーザーのパスワード。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Harborを無効にする
プロジェクトのHarborインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/harborHarbor設定を取得
プロジェクトのHarborインテグレーション設定を取得します。
GET /projects/:id/integrations/harborirker(IRCゲートウェイ)
irkerを設定
プロジェクトのirkerインテグレーションをセットアップします。
PUT /projects/:id/integrations/irkerパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
recipients | 文字列 | はい | チャンネルまたはメールアドレスのカンマ区切りリスト。 |
default_irc_uri | 文字列 | いいえ | 各受信者の前に追加するURI。デフォルト値はirc://irc.network.net:6697/です。 |
server_host | 文字列 | いいえ | irkerデーモンホスト名。デフォルト値はlocalhostです。 |
server_port | 整数 | いいえ | irkerデーモンポート。デフォルト値は6659です。 |
colorize_messages | ブール値 | いいえ | メッセージをカラー表示します。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
irkerを無効にする
プロジェクトのirkerインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/irkerirker設定を取得
プロジェクトのirkerインテグレーション設定を取得します。
GET /projects/:id/integrations/irkerJenkins
Jenkinsを設定
プロジェクトのJenkinsインテグレーションをセットアップします。
PUT /projects/:id/integrations/jenkinsパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
jenkins_url | 文字列 | はい | JenkinsサーバーのURL。 |
enable_ssl_verification | ブール値 | いいえ | SSL検証を有効にします。デフォルトはtrue(有効)。 |
project_name | 文字列 | はい | Jenkinsプロジェクトの名前。 |
username | 文字列 | いいえ | Jenkinsサーバーのユーザー名。 |
password | 文字列 | いいえ | Jenkinsサーバーのパスワード。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Jenkinsを無効にする
プロジェクトのJenkinsインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/jenkinsJenkins設定を取得
プロジェクトのJenkinsインテグレーション設定を取得します。
GET /projects/:id/integrations/jenkinsJetBrains TeamCity
JetBrains TeamCityを設定
プロジェクトのJetBrains TeamCityインテグレーションをセットアップします。
TeamCityのビルド構成では、ビルド番号形式%build.vcs.number%を使用する必要があります。マージリクエストをビルドできるように、VCSルートの詳細設定で、すべてのブランチのモニタリングを構成します。
PUT /projects/:id/integrations/teamcityパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
teamcity_url | 文字列 | はい | TeamCityルートURL(例:https://teamcity.example.com)。 |
enable_ssl_verification | ブール値 | いいえ | SSL検証を有効にします。デフォルトはtrue(有効)。 |
build_type | 文字列 | はい | TeamCityプロジェクトのビルド構成ID。 |
username | 文字列 | はい | 手動ビルドをトリガーする権限を持つユーザー。 |
password | 文字列 | はい | ユーザーのパスワード。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
JetBrains TeamCityを無効にする
プロジェクトのJetBrains TeamCityインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/teamcityJetBrains TeamCity設定を取得
プロジェクトのJetBrains TeamCityインテグレーション設定を取得します。
GET /projects/:id/integrations/teamcityJiraイシュー
Jiraイシューを設定
プロジェクトのJiraイシューインテグレーションをセットアップします。
PUT /projects/:id/integrations/jiraパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
url | 文字列 | はい | このGitLabプロジェクトにリンクされているJiraプロジェクトのURL(例:https://jira.example.com)。 |
api_url | 文字列 | いいえ | JiraインスタンスAPIへのベースURL。Web URLの値は、設定されていない場合に使用されます(例:https://jira-api.example.com)。 |
username | 文字列 | いいえ | Jiraで使用するメールまたはユーザー名。Jira Cloudにはメールを使用し、Jira Data CenterとJira Serverにはユーザー名を使用します。基本認証(jira_auth_typeが0)を使用する場合は必須。 |
password | 文字列 | はい | Jiraで使用するAPIトークン、パスワード、またはパーソナルアクセストークン。基本認証(jira_auth_typeが0)を使用する場合は、Jira CloudにはAPIトークンを使用し、Jira Data CenterまたはJira Serverにはパスワードを使用します。Jiraパーソナルアクセストークン(jira_auth_typeが1)の場合、パーソナルアクセストークンを使用します。 |
active | ブール値 | いいえ | インテグレーションをアクティブ化または非アクティブ化します。デフォルトはfalse(非アクティブ化)。 |
jira_auth_type | 整数 | いいえ | Jiraで使用する認証方式。基本認証には0を使用し、Jiraパーソナルアクセストークンには1を使用します。0がデフォルトです。 |
jira_issue_prefix | 文字列 | いいえ | Jiraイシューキーに一致するプレフィックス。 |
jira_issue_regex | 文字列 | いいえ | Jiraイシューキーに一致する正規表現。 |
jira_issue_transition_automatic | ブール値 | いいえ | イシューの自動移行を有効にします。有効にした場合、jira_issue_transition_idよりも優先されます。falseがデフォルトです。 |
jira_issue_transition_id | 文字列 | いいえ | カスタムイシュー移行の1つまたは複数のID。jira_issue_transition_automaticが有効になっている場合は無視されます。デフォルトは空白の文字列で、カスタム移行が無効になります。 |
commit_events | ブール値 | いいえ | コミットイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
comment_on_event_enabled | ブール値 | いいえ | 各GitLabイベント(コミットまたはマージリクエスト)で、Jiraイシューのコメントを有効にします。 |
issues_enabled | ブール値 | いいえ | GitLabでJiraイシューの表示を有効にします。GitLab 17.0で導入されました。 |
project_keys | 文字列の配列 | いいえ | Jiraプロジェクトのキー。issues_enabledがtrueの場合、この設定は、GitLabでイシューを表示するJiraプロジェクトを指定します。GitLab 17.0で導入されました。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
vulnerabilities_enabled | ブール値 | いいえ | GitLab EEでのみ利用可能です。trueに設定すると、GitLabの脆弱性に対してJiraイシューが作成されます。 |
vulnerabilities_issuetype | 数値 | いいえ | GitLab EEでのみ利用可能です。脆弱性からイシューを作成するときに使用するJiraイシュータイプのID。 |
project_key | 文字列 | いいえ | GitLab EEでのみ利用可能です。脆弱性からイシューを作成するときに使用するプロジェクトのキー。脆弱性からイシューを作成するためにインテグレーションを使用している場合、このパラメータは必須です。 |
customize_jira_issue_enabled | ブール値 | いいえ | GitLab EEでのみ利用可能です。trueに設定すると、脆弱性からJiraイシューを作成するときに、Jiraインスタンスに事前入力されたフォームが開きます。 |
Jiraを無効にする
プロジェクトのJiraイシューインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/jiraJira設定を取得
プロジェクトのJiraイシューインテグレーション設定を取得します。
GET /projects/:id/integrations/jiraLinear
Linearを設定
グループのLinearインテグレーションをセットアップします。
PUT /projects/:id/integrations/linearパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
workspace_url | 文字列 | はい | イシューのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Linearを無効にする
グループのLinearインテグレーションを無効にします。インテグレーション設定がリセットされます。
DELETE /projects/:id/integrations/linearLinear設定を取得
グループのLinearインテグレーション設定を取得します。
GET /projects/:id/integrations/linearMatrix通知
Matrix通知を設定
プロジェクトのMatrix通知をセットアップします。
PUT /projects/:id/integrations/matrixパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
hostname | 文字列 | いいえ | Matrixサーバーのカスタムホスト名。デフォルト値はhttps://matrix.orgです。 |
token | 文字列 | はい | Matrixアクセストークン(例:syt-zyx57W2v1u123ew11)。 |
room | 文字列 | はい | ターゲットルームの一意の識別子(!qPKKM111FFKKsfoCVy:matrix.org形式)。 |
notify_only_broken_pipelines | ブール値 | いいえ | 壊れたパイプラインの通知を送信します。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、default_and_protectedです。デフォルト値はdefaultです。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグプッシュイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密ノートイベントの通知を有効にします。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページのイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Matrix通知を無効にする
プロジェクトのMatrix通知を無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/matrixMatrix通知の設定を取得
プロジェクトのMatrix通知の設定を取得します。
GET /projects/:id/integrations/matrixMattermostの通知
Mattermostの通知の設定
プロジェクトのMattermost通知をセットアップします。
PUT /projects/:id/integrations/mattermostパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | Mattermost通知Webhook(例:http://mattermost.example.com/hooks/...)。 |
username | 文字列 | いいえ | Mattermost通知のユーザー名。 |
channel | 文字列 | いいえ | 他のチャンネルが構成されていない場合に使用するデフォルトチャンネル。 |
notify_only_broken_pipelines | ブール値 | いいえ | 壊れたパイプラインの通知を送信します。 |
notify_only_default_branch | ブール値 | いいえ | 非推奨: このパラメータは、branches_to_be_notifiedに置き換えられました。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、default_and_protectedです。デフォルト値はdefaultです。 |
labels_to_be_notified | 文字列 | いいえ | 通知を送信するラベル。すべてのイベントの通知を受信するには、空白のままにします。 |
labels_to_be_notified_behavior | 文字列 | いいえ | 通知を受け取るラベル。有効なオプションは、match_anyとmatch_allです。デフォルト値はmatch_anyです。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグプッシュイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密ノートイベントの通知を有効にします。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページのイベントの通知を有効にします。 |
push_channel | 文字列 | いいえ | プッシュイベントの通知を受信するチャンネルの名前。 |
issue_channel | 文字列 | いいえ | イシューイベントの通知を受信するチャンネルの名前。 |
confidential_issue_channel | 文字列 | いいえ | 機密イシューイベントの通知を受信するチャンネルの名前。 |
merge_request_channel | 文字列 | いいえ | マージリクエストイベントの通知を受信するチャンネルの名前。 |
note_channel | 文字列 | いいえ | ノートイベントの通知を受信するチャンネルの名前。 |
confidential_note_channel | 文字列 | いいえ | 機密ノートイベントの通知を受信するチャンネルの名前。 |
tag_push_channel | 文字列 | いいえ | タグプッシュイベントの通知を受信するチャンネルの名前。 |
pipeline_channel | 文字列 | いいえ | パイプラインイベントの通知を受信するチャンネルの名前。 |
wiki_page_channel | 文字列 | いいえ | Wikiページのイベントの通知を受信するチャンネルの名前。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Mattermostの通知を無効にします
プロジェクトのMattermost通知を無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/mattermostMattermost通知の設定を取得
プロジェクトのMattermost通知の設定を取得します。
GET /projects/:id/integrations/mattermostMattermostのスラッシュコマンド
Mattermostのスラッシュコマンドを設定
プロジェクトのMattermostスラッシュコマンドをセットアップします。
PUT /projects/:id/integrations/mattermost-slash-commandsパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | Mattermostトークン。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Mattermostのスラッシュコマンドを無効にします
プロジェクトのMattermostスラッシュコマンドを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/mattermost-slash-commandsMattermostスラッシュコマンドの設定を取得
プロジェクトのMattermostスラッシュコマンドの設定を取得します。
GET /projects/:id/integrations/mattermost-slash-commandsMicrosoft Teamsの通知
Microsoft Teams通知を選択します
プロジェクトのMicrosoft Teams通知をセットアップします。
PUT /projects/:id/integrations/microsoft-teamsパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | Microsoft Teams Webhook(例:https://outlook.office.com/webhook/...)。 |
notify_only_broken_pipelines | ブール値 | いいえ | 壊れたパイプラインの通知を送信します。 |
notify_only_default_branch | ブール値 | いいえ | 非推奨: このパラメータは、branches_to_be_notifiedに置き換えられました。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、default_and_protectedです。デフォルト値はdefaultです。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグプッシュイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密ノートイベントの通知を有効にします。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページのイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Microsoft Teams通知を選択します
プロジェクトのMicrosoft Teams通知を無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/microsoft-teamsMicrosoft Teams通知の設定を取得
プロジェクトのMicrosoft Teams通知の設定を取得します。
GET /projects/:id/integrations/microsoft-teamsモックCI
このインテグレーションは、開発環境でのみ使用できます。Mock CIサーバーの例については、gitlab-org/gitlab-mock-ci-serviceを参照してください。
Mock CIのセットアップ
プロジェクトのMock CIインテグレーションをセットアップします。
PUT /projects/:id/integrations/mock-ciパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
mock_service_url | 文字列 | はい | Mock CIインテグレーションのURL。 |
enable_ssl_verification | ブール値 | いいえ | SSL検証を有効にします。trueがデフォルトです(有効)。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Mock CIの無効化
プロジェクトのMock CIインテグレーションを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/mock-ciMock CIの設定を取得
プロジェクトのMock CIインテグレーションの設定を取得します。
GET /projects/:id/integrations/mock-ciPackagist
Packagistのセットアップ
プロジェクトのPackagistインテグレーションをセットアップします。
PUT /projects/:id/integrations/packagistパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
username | 文字列 | はい | Packagistアカウントのユーザー名。 |
token | 文字列 | はい | PackagistサーバーのAPIトークン。 |
server | ブール値 | いいえ | PackagistサーバーのURL。デフォルト値はhttps://packagist.orgです。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグプッシュイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Packagistの無効化
プロジェクトのPackagistインテグレーションを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/packagistPackagistの設定を取得
プロジェクトのPackagistインテグレーションの設定を取得します。
GET /projects/:id/integrations/packagistPhorge
Phorgeのセットアップ
プロジェクトのPhorgeインテグレーションをセットアップします。
PUT /projects/:id/integrations/phorgeパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
issues_url | 文字列 | はい | イシューのURL。 |
project_url | 文字列 | はい | プロジェクトのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Phorgeの無効化
プロジェクトのPhorgeインテグレーションを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/phorgePhorgeの設定を取得
プロジェクトのPhorgeインテグレーションの設定を取得します。
GET /projects/:id/integrations/phorgeパイプラインステータスメール
パイプラインステータスメールを設定
プロジェクトのパイプラインステータスのメールをセットアップします。
PUT /projects/:id/integrations/pipelines-emailパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
recipients | 文字列 | はい | コンマ区切りの受信者のメールアドレスのリスト。 |
notify_only_broken_pipelines | ブール値 | いいえ | 壊れたパイプラインの通知を送信します。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、default_and_protectedです。デフォルト値はdefaultです。 |
notify_only_default_branch | ブール値 | いいえ | デフォルトブランチの通知を送信します。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
パイプラインステータスのメールを無効にする
プロジェクトのパイプラインステータスのメールを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/pipelines-emailパイプラインステータスのメールの設定を取得
プロジェクトのパイプラインステータスのメールの設定を取得します。
GET /projects/:id/integrations/pipelines-emailPivotal Tracker
Pivotal Trackerのセットアップ
プロジェクトのPivotal Trackerインテグレーションをセットアップします。
PUT /projects/:id/integrations/pivotaltrackerパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | Pivotal Trackerのトークン。 |
restrict_to_branch | ブール値 | いいえ | 自動的に検査するブランチのコンマ区切りリスト。すべてのブランチを含めるには、空白のままにします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Pivotal Trackerの無効化
プロジェクトのPivotal Trackerインテグレーションを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/pivotaltrackerPivotal Trackerの設定を取得
プロジェクトのPivotal Trackerインテグレーションの設定を取得します。
GET /projects/:id/integrations/pivotaltrackerPumble
Pumbleのセットアップ
プロジェクトのPumbleインテグレーションをセットアップします。
PUT /projects/:id/integrations/pumbleパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | Pumble Webhook(例:https://api.pumble.com/workspaces/x/...)。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、default_and_protectedです。デフォルトはdefaultです。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密ノートイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
notify_only_broken_pipelines | ブール値 | いいえ | 壊れたパイプラインの通知を送信します。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグプッシュイベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページのイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Pumbleの無効化
プロジェクトのPumbleインテグレーションを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/pumblePumbleの設定を取得
プロジェクトのPumbleインテグレーションの設定を取得します。
GET /projects/:id/integrations/pumblePushover
Pushoverのセットアップ
プロジェクトのPushoverインテグレーションをセットアップします。
PUT /projects/:id/integrations/pushoverパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
api_key | 文字列 | はい | アプリケーションキー。 |
user_key | 文字列 | はい | ユーザーキー。 |
priority | 文字列 | はい | 優先度。 |
device | 文字列 | いいえ | すべてのアクティブなデバイスの場合は、空白のままにします。 |
sound | 文字列 | いいえ | 通知のサウンド。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Pushoverの無効化
プロジェクトのPushoverインテグレーションを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/pushoverPushoverの設定を取得
プロジェクトのPushoverインテグレーションの設定を取得します。
GET /projects/:id/integrations/pushoverRedmine
Redmineのセットアップ
プロジェクトのRedmineインテグレーションをセットアップします。
PUT /projects/:id/integrations/redmineパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
new_issue_url | 文字列 | はい | 新規イシューのURL。 |
project_url | 文字列 | はい | プロジェクトのURL。 |
issues_url | 文字列 | はい | イシューのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルトの設定を継承するかどうかを示します。falseがデフォルトです。 |
Redmineの無効化
プロジェクトのRedmineインテグレーションを無効にします。インテグレーションの設定がリセットされます。
DELETE /projects/:id/integrations/redmineRedmineの設定を取得
プロジェクトのRedmineインテグレーションの設定を取得します。
GET /projects/:id/integrations/redmineSlack通知
Slack通知のセットアップ
プロジェクトのSlack通知をセットアップします。
PUT /projects/:id/integrations/slackパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | Slack通知Webhook(例:https://hooks.slack.com/services/...)。 |
username | 文字列 | いいえ | Slack通知のユーザー名。 |
channel | 文字列 | いいえ | 他のチャンネルが構成されていない場合に使用するデフォルトチャンネル。 |
notify_only_broken_pipelines | ブール値 | いいえ | 破損したパイプラインの通知を送信します。 |
notify_only_default_branch | ブール値 | いいえ | 非推奨: このパラメータは、branches_to_be_notifiedに置き換えられました。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、およびdefault_and_protectedです。デフォルト値はdefaultです。 |
labels_to_be_notified | 文字列 | いいえ | 通知を送信するラベル。すべてのイベントの通知を受信するには、空白のままにします。 |
labels_to_be_notified_behavior | 文字列 | いいえ | 通知を受信するラベル。有効なオプションは、match_anyおよびmatch_allです。デフォルト値はmatch_anyです。 |
alert_channel | 文字列 | いいえ | アラートイベントの通知を受信するチャンネルの名前。 |
alert_events | ブール値 | いいえ | アラートイベントの通知を有効にします。 |
commit_events | ブール値 | いいえ | コミットイベントの通知を有効にします。 |
confidential_issue_channel | 文字列 | いいえ | 機密イシューイベントの通知を受信するチャンネルの名前。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
confidential_note_channel | 文字列 | いいえ | 機密ノートイベントの通知を受信するチャンネルの名前。 |
confidential_note_events | ブール値 | いいえ | 機密ノートイベントの通知を有効にします。 |
deployment_channel | 文字列 | いいえ | デプロイイベントの通知を受信するチャンネルの名前。 |
deployment_events | ブール値 | いいえ | デプロイイベントの通知を有効にします。 |
incident_channel | 文字列 | いいえ | インシデントイベントの通知を受信するチャンネルの名前。 |
incidents_events | ブール値 | いいえ | インシデントイベントの通知を有効にします。 |
issue_channel | 文字列 | いいえ | イシューイベントの通知を受信するチャンネルの名前。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
job_events | ブール値 | いいえ | ジョブイベントの通知を有効にします。 |
merge_request_channel | 文字列 | いいえ | マージリクエストイベントの通知を受信するチャンネルの名前。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
note_channel | 文字列 | いいえ | ノートイベントの通知を受信するチャンネルの名前。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
pipeline_channel | 文字列 | いいえ | パイプラインイベントの通知を受信するチャンネルの名前。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
push_channel | 文字列 | いいえ | プッシュイベントの通知を受信するチャンネルの名前。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
tag_push_channel | 文字列 | いいえ | タグ付けプッシュイベントの通知を受信するチャンネルの名前。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
wiki_page_channel | 文字列 | いいえ | Wikiページのイベントの通知を受信するチャンネルの名前。 |
wiki_page_events | ブール値 | いいえ | Wikiページのイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Slack通知を無効にする
プロジェクトのSlack通知を無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/slackSlack通知設定を取得
プロジェクトのSlack通知設定を取得します。
GET /projects/:id/integrations/slackSlackのスラッシュコマンド
Slackスラッシュコマンドを設定
プロジェクトのSlackスラッシュコマンドを設定します。
PUT /projects/:id/integrations/slack-slash-commandsパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
token | 文字列 | はい | Slackトークン。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Slackスラッシュコマンドを無効にする
プロジェクトのSlackスラッシュコマンドを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/slack-slash-commandsSlackスラッシュコマンド設定を取得
プロジェクトのSlackスラッシュコマンド設定を取得します。
GET /projects/:id/integrations/slack-slash-commandsレスポンス例:
{
"id": 4,
"title": "Slack slash commands",
"slug": "slack-slash-commands",
"created_at": "2017-06-27T05:51:39-07:00",
"updated_at": "2017-06-27T05:51:39-07:00",
"active": true,
"push_events": true,
"issues_events": true,
"confidential_issues_events": true,
"merge_requests_events": true,
"tag_push_events": true,
"note_events": true,
"job_events": true,
"pipeline_events": true,
"comment_on_event_enabled": false,
"inherited": false,
"properties": {
"token": "<your_access_token>"
}
}Squash TM
Squash TMを設定
プロジェクトのSquash TMインテグレーション設定を設定します。
PUT /projects/:id/integrations/squash-tmパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
url | 文字列 | はい | Squash TM WebhookのURL。 |
token | 文字列 | いいえ | シークレットトークン。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Squash TMを無効にする
プロジェクトのSquash TMインテグレーションを無効にします。インテグレーションの設定は保持されます。
DELETE /projects/:id/integrations/squash-tmSquash TM設定を取得
プロジェクトのSquash TMインテグレーション設定を取得します。
GET /projects/:id/integrations/squash-tmTelegram
Telegramを設定
プロジェクトのTelegramインテグレーションを設定します。
PUT /projects/:id/integrations/telegramパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
hostname | 文字列 | いいえ | Telegram APIのカスタムホスト名(GitLab 17.1で導入)。デフォルト値はhttps://api.telegram.orgです。 |
token | 文字列 | はい | Telegramボットトークン(例:123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11)。 |
room | 文字列 | はい | ターゲットチャットの固有識別子、またはターゲットチャンネルのユーザー名(@channelusername形式)。 |
thread | 整数 | いいえ | ターゲットメッセージスレッドの固有識別子(フォーラムスーパーグループのトピック)。GitLab 16.11で導入されました。 |
notify_only_broken_pipelines | ブール値 | いいえ | 破損したパイプラインの通知を送信します。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ(GitLab 16.5で導入)。有効なオプションは、all、default、protected、およびdefault_and_protectedです。デフォルト値はdefaultです。 |
push_events | ブール値 | はい | プッシュイベントの通知を有効にします。 |
issues_events | ブール値 | はい | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | はい | 機密イシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | はい | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | はい | タグ付けプッシュイベントの通知を有効にします。 |
note_events | ブール値 | はい | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | はい | 機密ノートイベントの通知を有効にします。 |
pipeline_events | ブール値 | はい | パイプラインイベントの通知を有効にします。 |
wiki_page_events | ブール値 | はい | Wikiページのイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Telegramを無効にする
プロジェクトのTelegramインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/telegramTelegram設定を取得
プロジェクトのTelegramインテグレーション設定を取得します。
GET /projects/:id/integrations/telegramUnify Circuit
Unify Circuitを設定
プロジェクトのUnify Circuitインテグレーションを設定します。
PUT /projects/:id/integrations/unify-circuitパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | Unify Circuit Webhook(例:https://circuit.com/rest/v2/webhooks/incoming/...)。 |
notify_only_broken_pipelines | ブール値 | いいえ | 破損したパイプラインの通知を送信します。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、およびdefault_and_protectedです。デフォルト値はdefaultです。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密ノートイベントの通知を有効にします。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページのイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Unify Circuitを無効にする
プロジェクトのUnify Circuitインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/unify-circuitUnify Circuit設定を取得
プロジェクトのUnify Circuitインテグレーション設定を取得します。
GET /projects/:id/integrations/unify-circuitWebex Teams
Webex Teamsを設定
プロジェクトのWebex Teamsを設定します。
PUT /projects/:id/integrations/webex-teamsパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
webhook | 文字列 | はい | Webex Teams Webhook(例:https://api.ciscospark.com/v1/webhooks/incoming/...)。 |
notify_only_broken_pipelines | ブール値 | いいえ | 破損したパイプラインの通知を送信します。 |
branches_to_be_notified | 文字列 | いいえ | 通知を送信するブランチ。有効なオプションは、all、default、protected、およびdefault_and_protectedです。デフォルト値はdefaultです。 |
push_events | ブール値 | いいえ | プッシュイベントの通知を有効にします。 |
issues_events | ブール値 | いいえ | イシューイベントの通知を有効にします。 |
confidential_issues_events | ブール値 | いいえ | 機密イシューイベントの通知を有効にします。 |
merge_requests_events | ブール値 | いいえ | マージリクエストイベントの通知を有効にします。 |
tag_push_events | ブール値 | いいえ | タグ付けプッシュイベントの通知を有効にします。 |
note_events | ブール値 | いいえ | ノートイベントの通知を有効にします。 |
confidential_note_events | ブール値 | いいえ | 機密ノートイベントの通知を有効にします。 |
pipeline_events | ブール値 | いいえ | パイプラインイベントの通知を有効にします。 |
wiki_page_events | ブール値 | いいえ | Wikiページのイベントの通知を有効にします。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
Webex Teamsを無効にする
プロジェクトのWebex Teamsを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/webex-teamsWebex Teams設定を取得
プロジェクトのWebex Teams設定を取得します。
GET /projects/:id/integrations/webex-teamsYouTrack
YouTrackを設定
プロジェクトのYouTrackインテグレーションを設定します。
PUT /projects/:id/integrations/youtrackパラメータは以下のとおりです:
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
issues_url | 文字列 | はい | イシューのURL。 |
project_url | 文字列 | はい | プロジェクトのURL。 |
use_inherited_settings | ブール値 | いいえ | デフォルト設定を継承するかどうかを示します。falseがデフォルトです。 |
YouTrackを無効にする
プロジェクトのYouTrackインテグレーションを無効にします。インテグレーションの設定はリセットされます。
DELETE /projects/:id/integrations/youtrackYouTrack設定を取得
プロジェクトのYouTrackインテグレーション設定を取得します。
GET /projects/:id/integrations/youtrack