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

プロジェクトインテグレーション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_store

Apple App Store Connect設定を取得

プロジェクトのApple App Store Connectインテグレーション設定を取得します。

GET /projects/:id/integrations/apple_app_store

Asana

Asanaを設定

プロジェクトのAsanaインテグレーションを設定します。

PUT /projects/:id/integrations/asana

パラメータは以下のとおりです:

パラメータ必須説明
api_key文字列はいユーザーAPIトークン。ユーザーはタスクにアクセスできる必要があります。すべてのコメントは、このユーザーに起因します。
restrict_to_branch文字列いいえ自動的に検査されるブランチのコンマ区切りリスト。すべてのブランチを含めるには、空白のままにします。
use_inherited_settingsブール値いいえデフォルト設定を継承するかどうかを示します。falseがデフォルトです。

Asanaを無効にする

プロジェクトのAsanaインテグレーションを無効にします。インテグレーション設定がリセットされました。

DELETE /projects/:id/integrations/asana

Asana設定を取得

プロジェクトのAsanaインテグレーション設定を取得します。

GET /projects/:id/integrations/asana

Assembla

Assemblaを設定

プロジェクトのAssemblaインテグレーションを設定します。

PUT /projects/:id/integrations/assembla

パラメータは以下のとおりです:

パラメータ必須説明
token文字列はい認証トークン。
subdomain文字列いいえサブドメイン設定。
use_inherited_settingsブール値いいえデフォルト設定を継承するかどうかを示します。falseがデフォルトです。

Assemblaを無効にする

プロジェクトのAssemblaインテグレーションを無効にします。インテグレーション設定がリセットされました。

DELETE /projects/:id/integrations/assembla

Assembla設定を取得

プロジェクトのAssemblaインテグレーション設定を取得します。

GET /projects/:id/integrations/assembla

Atlassian 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/bamboo

Atlassian Bamboo設定を取得

プロジェクトのAtlassian Bambooインテグレーション設定を取得します。

GET /projects/:id/integrations/bamboo

Bugzilla

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/bugzilla

Bugzilla設定を取得

プロジェクトのBugzillaインテグレーション設定を取得します。

GET /projects/:id/integrations/bugzilla

Buildkite

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/buildkite

Buildkite設定を取得

プロジェクトのBuildkiteインテグレーション設定を取得します。

GET /projects/:id/integrations/buildkite

Campfire 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/campfire

Campfire Classic設定を取得

プロジェクトのCampfire Classicインテグレーション設定を取得します。

GET /projects/:id/integrations/campfire

ClickUp

ClickUpを設定

プロジェクトのClickUpインテグレーションを設定します。

PUT /projects/:id/integrations/clickup

パラメータは以下のとおりです:

パラメータ必須説明
issues_url文字列はいイシューのURL。
project_url文字列はいプロジェクトのURL。
use_inherited_settingsブール値いいえデフォルト設定を継承するかどうかを示します。falseがデフォルトです。

ClickUpを無効にする

プロジェクトのClickUpインテグレーションを無効にします。インテグレーション設定がリセットされました。

DELETE /projects/:id/integrations/clickup

ClickUp設定を取得

プロジェクトのClickUpインテグレーション設定を取得します。

GET /projects/:id/integrations/clickup

Confluenceワークスペース

プロジェクトの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/confluence

Confluenceワークスペース設定を取得

プロジェクトの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-tracker

Datadog

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/datadog

Datadog設定を取得

プロジェクトのDatadogインテグレーション設定を取得します。

GET /projects/:id/integrations/datadog

Diffblue 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-cover

Diffblue Cover設定を取得

プロジェクトのDiffblue Coverインテグレーション設定を取得します。

GET /projects/:id/integrations/diffblue-cover

Discordの通知

Discordの通知を設定

プロジェクトのDiscord通知を設定します。

PUT /projects/:id/integrations/discord

パラメータは以下のとおりです:

パラメータ必須説明
webhook文字列はいDiscord Webhook(例:https://discord.com/api/webhooks/...)。
branches_to_be_notified文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotected、および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/discord

Discord通知設定を取得

プロジェクトのDiscord通知設定を取得します。

GET /projects/:id/integrations/discord

Drone

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-ci

Drone設定を取得

プロジェクトの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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotected、およびdefault_and_protectedです。通知は、タグ付けのプッシュで常にトリガーされます。デフォルト値はallです。
use_inherited_settingsブール値いいえデフォルトの設定を継承するかどうかを示します。falseがデフォルトです。

プッシュ時にメールを送信を無効にする

プロジェクトのプッシュ時にメールを送信インテグレーションを無効にします。インテグレーションの設定はリセットされます。

DELETE /projects/:id/integrations/emails-on-push

プッシュ時にメールを送信設定を取得

プロジェクトのプッシュ時にメールを送信インテグレーションの設定を取得します。

GET /projects/:id/integrations/emails-on-push

Engineeringワークフロー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/ewm

EWM設定を取得

プロジェクトの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-wiki

GitGuardian

  • プラン: 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-guardian

GitGuardian設定を取得

プロジェクトのGitGuardianインテグレーションの設定を取得します。

GET /projects/:id/integrations/git-guardian

GitHub

  • プラン: 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/github

GitHub設定を取得

プロジェクトのGitHubインテグレーションの設定を取得します。

GET /projects/:id/integrations/github

GitLab 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-app

GitLab 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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotected、および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_anymatch_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-application

Slackアプリの設定を取得

プロジェクトのSlackアプリの統合設定を取得します。

GET /projects/:id/integrations/gitlab-slack-application

Google 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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotected、および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-chat

Google Chat設定を取得

プロジェクトのGoogle Chatインテグレーションの設定を取得します。

GET /projects/:id/integrations/hangouts-chat

Google 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-registry

Googleアーティファクト管理設定の取得

プロジェクトのGoogleアーティファクト管理インテグレーション設定を取得します。

GET /projects/:id/integrations/google-cloud-platform-artifact-registry

Google 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-federation

Google Cloud Identity and Access Managementの取得

プロジェクトのGoogle Cloud Identity and Access Managementの設定を取得します。

GET /projects/:id/integration/google-cloud-platform-workload-identity-federation

Google 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-play

Google Play設定を取得

プロジェクトのGoogle Playインテグレーション設定を取得します。

GET /projects/:id/integrations/google-play

Harbor

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/harbor

Harbor設定を取得

プロジェクトのHarborインテグレーション設定を取得します。

GET /projects/:id/integrations/harbor

irker(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/irker

irker設定を取得

プロジェクトのirkerインテグレーション設定を取得します。

GET /projects/:id/integrations/irker

Jenkins

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/jenkins

Jenkins設定を取得

プロジェクトのJenkinsインテグレーション設定を取得します。

GET /projects/:id/integrations/jenkins

JetBrains 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/teamcity

JetBrains TeamCity設定を取得

プロジェクトのJetBrains TeamCityインテグレーション設定を取得します。

GET /projects/:id/integrations/teamcity

Jiraイシュー

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_type0)を使用する場合は必須。
password文字列はいJiraで使用するAPIトークン、パスワード、またはパーソナルアクセストークン。基本認証(jira_auth_type0)を使用する場合は、Jira CloudにはAPIトークンを使用し、Jira Data CenterまたはJira Serverにはパスワードを使用します。Jiraパーソナルアクセストークン(jira_auth_type1)の場合、パーソナルアクセストークンを使用します。
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_enabledtrueの場合、この設定は、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/jira

Jira設定を取得

プロジェクトのJiraイシューインテグレーション設定を取得します。

GET /projects/:id/integrations/jira

Linear

Linearを設定

グループのLinearインテグレーションをセットアップします。

PUT /projects/:id/integrations/linear

パラメータは以下のとおりです:

パラメータ必須説明
workspace_url文字列はいイシューのURL。
use_inherited_settingsブール値いいえデフォルト設定を継承するかどうかを示します。falseがデフォルトです。

Linearを無効にする

グループのLinearインテグレーションを無効にします。インテグレーション設定がリセットされます。

DELETE /projects/:id/integrations/linear

Linear設定を取得

グループのLinearインテグレーション設定を取得します。

GET /projects/:id/integrations/linear

Matrix通知

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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotecteddefault_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/matrix

Matrix通知の設定を取得

プロジェクトのMatrix通知の設定を取得します。

GET /projects/:id/integrations/matrix

Mattermostの通知

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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotecteddefault_and_protectedです。デフォルト値はdefaultです。
labels_to_be_notified文字列いいえ通知を送信するラベル。すべてのイベントの通知を受信するには、空白のままにします。
labels_to_be_notified_behavior文字列いいえ通知を受け取るラベル。有効なオプションは、match_anymatch_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/mattermost

Mattermost通知の設定を取得

プロジェクトのMattermost通知の設定を取得します。

GET /projects/:id/integrations/mattermost

Mattermostのスラッシュコマンド

Mattermostのスラッシュコマンドを設定

プロジェクトのMattermostスラッシュコマンドをセットアップします。

PUT /projects/:id/integrations/mattermost-slash-commands

パラメータは以下のとおりです:

パラメータ必須説明
token文字列はいMattermostトークン。
use_inherited_settingsブール値いいえデフォルトの設定を継承するかどうかを示します。falseがデフォルトです。

Mattermostのスラッシュコマンドを無効にします

プロジェクトのMattermostスラッシュコマンドを無効にします。インテグレーションの設定がリセットされます。

DELETE /projects/:id/integrations/mattermost-slash-commands

Mattermostスラッシュコマンドの設定を取得

プロジェクトのMattermostスラッシュコマンドの設定を取得します。

GET /projects/:id/integrations/mattermost-slash-commands

Microsoft 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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotecteddefault_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-teams

Microsoft 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-ci

Mock CIの設定を取得

プロジェクトのMock CIインテグレーションの設定を取得します。

GET /projects/:id/integrations/mock-ci

Packagist

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/packagist

Packagistの設定を取得

プロジェクトのPackagistインテグレーションの設定を取得します。

GET /projects/:id/integrations/packagist

Phorge

Phorgeのセットアップ

プロジェクトのPhorgeインテグレーションをセットアップします。

PUT /projects/:id/integrations/phorge

パラメータは以下のとおりです:

パラメータ必須説明
issues_url文字列はいイシューのURL。
project_url文字列はいプロジェクトのURL。
use_inherited_settingsブール値いいえデフォルトの設定を継承するかどうかを示します。falseがデフォルトです。

Phorgeの無効化

プロジェクトのPhorgeインテグレーションを無効にします。インテグレーションの設定がリセットされます。

DELETE /projects/:id/integrations/phorge

Phorgeの設定を取得

プロジェクトのPhorgeインテグレーションの設定を取得します。

GET /projects/:id/integrations/phorge

パイプラインステータスメール

パイプラインステータスメールを設定

プロジェクトのパイプラインステータスのメールをセットアップします。

PUT /projects/:id/integrations/pipelines-email

パラメータは以下のとおりです:

パラメータ必須説明
recipients文字列はいコンマ区切りの受信者のメールアドレスのリスト。
notify_only_broken_pipelinesブール値いいえ壊れたパイプラインの通知を送信します。
branches_to_be_notified文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotecteddefault_and_protectedです。デフォルト値はdefaultです。
notify_only_default_branchブール値いいえデフォルトブランチの通知を送信します。
pipeline_eventsブール値いいえパイプラインイベントの通知を有効にします。
use_inherited_settingsブール値いいえデフォルトの設定を継承するかどうかを示します。falseがデフォルトです。

パイプラインステータスのメールを無効にする

プロジェクトのパイプラインステータスのメールを無効にします。インテグレーションの設定がリセットされます。

DELETE /projects/:id/integrations/pipelines-email

パイプラインステータスのメールの設定を取得

プロジェクトのパイプラインステータスのメールの設定を取得します。

GET /projects/:id/integrations/pipelines-email

Pivotal 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/pivotaltracker

Pivotal Trackerの設定を取得

プロジェクトのPivotal Trackerインテグレーションの設定を取得します。

GET /projects/:id/integrations/pivotaltracker

Pumble

Pumbleのセットアップ

プロジェクトのPumbleインテグレーションをセットアップします。

PUT /projects/:id/integrations/pumble

パラメータは以下のとおりです:

パラメータ必須説明
webhook文字列はいPumble Webhook(例:https://api.pumble.com/workspaces/x/...)。
branches_to_be_notified文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotecteddefault_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/pumble

Pumbleの設定を取得

プロジェクトのPumbleインテグレーションの設定を取得します。

GET /projects/:id/integrations/pumble

Pushover

Pushoverのセットアップ

プロジェクトのPushoverインテグレーションをセットアップします。

PUT /projects/:id/integrations/pushover

パラメータは以下のとおりです:

パラメータ必須説明
api_key文字列はいアプリケーションキー。
user_key文字列はいユーザーキー。
priority文字列はい優先度。
device文字列いいえすべてのアクティブなデバイスの場合は、空白のままにします。
sound文字列いいえ通知のサウンド。
use_inherited_settingsブール値いいえデフォルトの設定を継承するかどうかを示します。falseがデフォルトです。

Pushoverの無効化

プロジェクトのPushoverインテグレーションを無効にします。インテグレーションの設定がリセットされます。

DELETE /projects/:id/integrations/pushover

Pushoverの設定を取得

プロジェクトのPushoverインテグレーションの設定を取得します。

GET /projects/:id/integrations/pushover

Redmine

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/redmine

Redmineの設定を取得

プロジェクトのRedmineインテグレーションの設定を取得します。

GET /projects/:id/integrations/redmine

Slack通知

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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotected、および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/slack

Slack通知設定を取得

プロジェクトのSlack通知設定を取得します。

GET /projects/:id/integrations/slack

Slackのスラッシュコマンド

Slackスラッシュコマンドを設定

プロジェクトのSlackスラッシュコマンドを設定します。

PUT /projects/:id/integrations/slack-slash-commands

パラメータは以下のとおりです:

パラメータ必須説明
token文字列はいSlackトークン。
use_inherited_settingsブール値いいえデフォルト設定を継承するかどうかを示します。falseがデフォルトです。

Slackスラッシュコマンドを無効にする

プロジェクトのSlackスラッシュコマンドを無効にします。インテグレーションの設定はリセットされます。

DELETE /projects/:id/integrations/slack-slash-commands

Slackスラッシュコマンド設定を取得

プロジェクトの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-tm

Squash TM設定を取得

プロジェクトのSquash TMインテグレーション設定を取得します。

GET /projects/:id/integrations/squash-tm

Telegram

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で導入)。有効なオプションは、alldefaultprotected、および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/telegram

Telegram設定を取得

プロジェクトのTelegramインテグレーション設定を取得します。

GET /projects/:id/integrations/telegram

Unify 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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotected、および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-circuit

Unify Circuit設定を取得

プロジェクトのUnify Circuitインテグレーション設定を取得します。

GET /projects/:id/integrations/unify-circuit

Webex 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文字列いいえ通知を送信するブランチ。有効なオプションは、alldefaultprotected、および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-teams

Webex Teams設定を取得

プロジェクトのWebex Teams設定を取得します。

GET /projects/:id/integrations/webex-teams

YouTrack

YouTrackを設定

プロジェクトのYouTrackインテグレーションを設定します。

PUT /projects/:id/integrations/youtrack

パラメータは以下のとおりです:

パラメータ必須説明
issues_url文字列はいイシューのURL。
project_url文字列はいプロジェクトのURL。
use_inherited_settingsブール値いいえデフォルト設定を継承するかどうかを示します。falseがデフォルトです。

YouTrackを無効にする

プロジェクトのYouTrackインテグレーションを無効にします。インテグレーションの設定はリセットされます。

DELETE /projects/:id/integrations/youtrack

YouTrack設定を取得

プロジェクトのYouTrackインテグレーション設定を取得します。

GET /projects/:id/integrations/youtrack