インテグレーションAPI

GitLabとインテグレーションする外部サービスと連携するためのAPIです。

note
GitLab 14.4 では、services のエンドポイントはintegrationsに名前が変更されました。インテグレーション API への呼び出しは、/projects/:id/services と/projects/:id/integrations. /projects/:id/integrationsNET の両方に行うことができます。/projects/:id/integrationsこのドキュメントの例では、.NET のエンド /projects/:id/integrationsポイントを参照しています。

この API には、メンテナーまたはオーナーのロールを持つアクセストークンが必要です。

すべてのアクティブなインテグレーションをリストします。

GitLab 12.7から導入されました。

アクティブなプロジェクトインテグレーションのリストを取得します。

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
  },
  {
    "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
  }
]

Apple App Store

GitLabを使ってアプリをビルドし、Apple App Storeでリリースしましょう。

Apple App Storeインテグレーションドキュメントもご覧ください。

Apple App Storeインテグレーションを作成/編集

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

PUT /projects/:id/integrations/apple_app_store

パラメータを指定します：

パラメータ種類必須説明
app_store_issuer_id文字列です。trueApple App Store Connectの発行者IDです。
app_store_key_id文字列です。trueApple App Store Connect Key ID。
app_store_private_key文字列です。trueApple App Store Connect秘密鍵。
app_store_protected_refsbooleanfalse保護されたブランチとタグにのみ変数を設定します。デフォルトはtrue (有効) です。

Apple App Storeインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/apple_app_store

Apple App Storeインテグレーション設定の取得

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

GET /projects/:id/integrations/apple_app_store

アサナ

コミットメッセージを Asana タスクにコメントとして追加します。

Asana インテグレーションドキュメントも参照してください。

Asana インテグレーションの作成/編集

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

PUT /projects/:id/integrations/asana

パラメータを指定します：

パラメータ種類必須説明
api_key文字列です。trueユーザーAPIトークン。ユーザーはタスクにアクセスできる必要があります。すべてのコメントはこのユーザーに帰属します。
restrict_to_branch文字列です。false自動的に検査されるブランチをカンマで区切ったリスト。すべてのブランチを含める場合は空白にしてください。

Asana インテグレーションを無効にします。

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

DELETE /projects/:id/integrations/asana

Asana インテグレーション設定を取得

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

GET /projects/:id/integrations/asana

アセンブラ

プロジェクト管理ソフトウェア (ソースコミットエンドポイント)

アセンブラの作成/編集インテグレーション

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

PUT /projects/:id/integrations/assembla

パラメータを指定します：

パラメータ種類必須説明
token文字列です。true認証トークン
subdomain文字列です。falseサブドメインの設定

Assemblaインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/assembla

Assembla インテグレーション設定の取得

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

GET /projects/:id/integrations/assembla

アトラシアン Bamboo CI

継続的インテグレーション・ビルドサーバー

Atlassian Bamboo CI インテグレーションの作成/編集

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

Bamboo で自動リビジョンラベリングとリポジトリトリガーを設定する必要があります。

PUT /projects/:id/integrations/bamboo

パラメータを指定します：

パラメータ種類必須説明
bamboo_url文字列です。trueBamboo ルート URL。たとえば、https://bamboo.example.com.
enable_ssl_verificationbooleanfalseSSL検証を有効にします。デフォルトはtrue（有効）です。
build_key文字列です。trueKEYのようなBambooビルドプランキー
username文字列です。trueAPIアクセス権を持つユーザー（該当する場合
password文字列です。trueユーザーのパスワード

Atlassian Bamboo CI インテグレーションを無効にします。

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

DELETE /projects/:id/integrations/bamboo

Atlassian Bamboo CI インテグレーションの設定を取得します。

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

GET /projects/:id/integrations/bamboo

Bugzilla

バグジラのイシュートラッカー

作成/編集 Bugzillaインテグレーション

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

PUT /projects/:id/integrations/bugzilla

パラメータを指定します：

パラメータ種類必須説明
new_issue_url文字列です。true新しいイシューのURL
issues_url文字列です。trueイシューURL
project_url文字列です。trueプロジェクトの URL

Bugzillaインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/bugzilla

Bugzilla インテグレーション設定の取得

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

GET /projects/:id/integrations/bugzilla

ビルドカイト

継続的インテグレーションとデプロイ

Buildkiteインテグレーションの作成/編集

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

PUT /projects/:id/integrations/buildkite

パラメータを指定します：

パラメータ種類必須説明
token文字列です。trueBuildkiteプロジェクトGitLabトークン
project_url文字列です。trueパイプラインのURL。例えばhttps://buildkite.com/example/pipeline
enable_ssl_verificationbooleanfalse廃止予定：SSL 検証は常に有効なので、このパラメータは何の効果もありません。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。

Buildkiteインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/buildkite

Buildkiteインテグレーション設定の取得

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

GET /projects/:id/integrations/buildkite

キャンプファイヤー

CAMPFIREのチャットルームにプッシュイベントを通知します。新規ユーザー登録ができなくなりました。

Campfireインテグレーションを作成/編集します。

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

PUT /projects/:id/integrations/campfire

パラメータを指定します：

パラメータ種類必須説明
token文字列です。trueCampfireのAPIトークンです。CAMPFIREにサインインし、[My info]を選択してください。
subdomain文字列です。falseキャンプファイヤーのサブドメインです。ログイン時、https:// から.campfirenow.com の間にテキストを入力してください。
room文字列です。falseキャンプファイヤーの部屋。部屋にいるときのURLの最後の部分。

Campfireインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/campfire

Campfireインテグレーション設定の取得

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

GET /projects/:id/integrations/campfire

クリックアップ

GitLab 16.1 で導入されました。

ClickUp イシュー・トラッカー。

ClickUpインテグレーションを作成または編集します。

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

PUT /projects/:id/integrations/clickup

パラメータを指定します：

パラメータ種類必須説明
issues_url文字列です。trueイシューURL
project_url文字列です。trueプロジェクトの URL

ClickUpインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/clickup

ClickUpインテグレーション設定の取得

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

GET /projects/:id/integrations/clickup

データドッグ

Datadogのシステム監視。

Datadog インテレーションの作成/編集

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

PUT /projects/:id/integrations/datadog

パラメータを指定します：

パラメータ種類必須説明
api_key文字列です。trueDatadog での認証に使用する API キー。
api_url文字列です。false(詳細) Datadog サイトの完全な URL
datadog_env文字列です。false自己管理型のデプロイでは、Datadog に送信するすべてのデータに env% タグを設定します。
datadog_service文字列です。falseこのGitLabインスタンスの全てのデータをDatadogでタグ付けします。複数のセルフマネージドデプロイを管理する場合に便利です。
datadog_site文字列です。falseデータを送信する Datadog サイト。EUのサイトにデータを送信するにはdatadoghq.eu
datadog_tags文字列です。falseDatadogのカスタムタグ。key:value\nkey2:value2 （GitLab14.8で導入）。
archive_trace_eventsbooleanfalse有効にすると、ジョブのログがDatadogによって収集され、パイプラインの実行トレースと共に表示されます(GitLab 15.3で導入)

Datadogインテグレーションを無効化

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

DELETE /projects/:id/integrations/datadog

Datadog インテグレーション設定の取得

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

GET /projects/:id/integrations/datadog

テレグラム

テレグラムチャットツール。

Telegramインテグレーションを作成/編集

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

PUT /projects/:id/integrations/telegram

パラメータを指定します：

パラメータ種類必須説明
token文字列です。trueTelegram ボットトークン。例えば、123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11 。
room文字列です。trueターゲットチャットの一意識別子またはターゲットチャンネルのユーザー名 (@channelusername 形式)
push_eventsbooleantrueプッシュイベントの通知を有効にします。
issues_eventsbooleantrueイシュー・イベントの通知を有効にします。
confidential_issues_eventsbooleantrue機密イシュー・イベントの通知を有効にします。
merge_requests_eventsbooleantrueマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleantrueタグプッシュイベントの通知を有効にします。
note_eventsbooleantrueノートイベントの通知を有効にします。
confidential_note_eventsbooleantrue秘密メモイベントの通知を有効にします。
pipeline_eventsbooleantrueパイプラインイベントの通知を有効にします。
wiki_page_eventsbooleantrueWikiページイベントの通知を有効にします。

Telegramインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/telegram

Telegramインテグレーション設定を取得

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

GET /projects/:id/integrations/telegram

サーキットの統一

Unify Circuit RTCとコラボレーションツール。

Unify Circuit インテグレーションの作成/編集

プロジェクトにユニファイ回路インテグレーションを設定します。

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

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。trueUnify Circuit Webhook。例えば、https://circuit.com/rest/v2/webhooks/incoming/....
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
note_eventsbooleanfalseノートイベントの通知を有効にします。
confidential_note_eventsbooleanfalse秘密メモイベントの通知を有効にします。
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。

Unify Circuitインテグレーションを無効にします。

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

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

Unify Circuit インテグレーション設定の取得

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

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

パンブル

Pumbleチャットツール。

Pumbleインテグレーションを作成/編集

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

PUT /projects/:id/integrations/pumble

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。truePumble Webhook。例えば、https://api.pumble.com/workspaces/x/....
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルトはdefaultです。
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
confidential_note_eventsbooleanfalse秘密ノートイベントの通知を有効にします。
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
note_eventsbooleanfalseノートイベントの通知を有効にします。
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信します。
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。

Pumbleインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/pumble

Pumbleインテグレーション設定の取得

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

GET /projects/:id/integrations/pumble

Webex チーム

Webex Teamsコラボレーションツール。

Webex Teamsインテグレーションを作成/編集

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

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

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。trueWebex Teams Webhook。例えば、https://api.ciscospark.com/v1/webhooks/incoming/....
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
note_eventsbooleanfalseノートイベントの通知を有効にします。
confidential_note_eventsbooleanfalse秘密メモイベントの通知を有効にします。
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。

Webex Teamsインテグレーションを無効にします。

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

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

Webex Teamsインテグレーション設定の取得

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

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

カスタムイシュートラッカー

カスタム課題管理ツール

カスタムイシュートラッカーの作成/編集インテグレーション

プロジェクトにカスタム課題追跡システムインテグレーションを設定します。

PUT /projects/:id/integrations/custom-issue-tracker

パラメータを指定します：

パラメータ種類必須説明
new_issue_url文字列です。true新しいイシューのURL
issues_url文字列です。trueイシューURL
project_url文字列です。trueプロジェクトの URL

カスタムイシュートラッカーとのインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/custom-issue-tracker

Custom Issue Trackerのインテグレーション設定を取得します。

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

GET /projects/:id/integrations/custom-issue-tracker

Discord

プロジェクトイベントに関する通知を Discord チャンネルに送信します。

Discord インテグレーションの作成/編集

_channel GitLab 16.3で導入されたパラメータです。

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

PUT /projects/:id/integrations/discord

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。trueDiscord Webhook。例えばhttps://discord.com/api/webhooks/…
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
confidential_issue_channel文字列です。false機密イシューイベント通知を受け取るためのWebhookオーバーライド
confidential_note_eventsbooleanfalse秘密メモイベントの通知を有効にします。
confidential_note_channel文字列です。false機密メモイベント通知を受け取るWebhookオーバーライド
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
issue_channel文字列です。falseイシューイベント通知を受け取るためのWebhookオーバーライド
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
merge_request_channel文字列です。falseマージリクエストイベントの通知を受け取るための Webhook オーバーライド。
note_eventsbooleanfalseノートイベントの通知を有効にします。
note_channel文字列です。falseノートイベント通知を受け取るWebhookオーバーライド
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
pipeline_channel文字列です。falseパイプラインイベントの通知を受け取るための Webhook オーバーライド。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
push_channel文字列です。falseプッシュイベント通知を受け取るWebhookオーバーライド
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
tag_push_channel文字列です。falseタグのプッシュイベント通知を受け取るためのWebhookオーバーライド
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。
wiki_page_channel文字列です。falseWikiページイベント通知を受け取るためのWebhookオーバーライド

Discordインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/discord

Discordインテグレーション設定を取得

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

GET /projects/:id/integrations/discord

ドローンCI

DroneはDocker上で構築され、Goで書かれた継続的インテグレーションプラットフォームです。

DroneのCIインテグレーションを作成/編集します。

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

PUT /projects/:id/integrations/drone-ci

パラメータを指定します：

パラメータ種類必須説明
token文字列です。trueDrone CIプロジェクト固有のトークン
drone_url文字列です。truehttp://drone.example.com
enable_ssl_verificationbooleanfalseSSL検証を有効にします。デフォルトはtrue（有効）です。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。

Drone CIインテグレーションを無効化

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

DELETE /projects/:id/integrations/drone-ci

Drone CIインテグレーション設定を取得

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

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

プッシュメール

各プッシュのコミットと差分を受信者リストにメールで送信します。

プッシュ統合時のメール作成/編集

プロジェクトにプッシュ統合メールを設定します。

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

パラメータを指定します：

パラメータ種類必須説明
recipients文字列です。true空白で区切られた電子メール
disable_diffsbooleanfalseコードの差分を無効にします。
send_from_committer_emailbooleanfalseコミッターから送信
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。タグのプッシュに対しては常に通知が送信されます。デフォルト値は “all” です。

プッシュ統合時のメールを無効にします。

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

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

プッシュ通知メールのインテグレーション設定を取得します。

プロジェクトのPushインテグレーション設定に関するメールを取得します。

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

エンジニアリングワークフロー管理(EWM)

IBM Engineering Workflow Management(EWM) をプロジェクトのイシュー・トラッカーとして使用します。

EWM インテグレーションの作成/編集

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

PUT /projects/:id/integrations/ewm

パラメータを指定します：

パラメータ種類必須説明
new_issue_url文字列です。trueEWMでイシューを作成するためのURL
project_url文字列です。trueEWMのプロジェクトURL
issues_url文字列です。trueEWMでイシューを表示するためのURL。コンテナ:id

EWMインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/ewm

EWMインテグレーション設定の取得

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

GET /projects/:id/integrations/ewm

Confluence インテグレーション

GitLab 13.2 で導入されました。

内部 Wiki へのリンクを Confluence クラウドワークスペースへのリンクに置き換えます。

Confluence インテグレーションの作成/編集

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

PUT /projects/:id/integrations/confluence

パラメータを指定します：

パラメータ種類必須説明
confluence_url文字列です。trueatlassian.net でホストされている Confluence クラウドワークスペースの URL。

Confluence インテグレーションを無効にします。

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

DELETE /projects/:id/integrations/confluence

Confluence インテグレーション設定の取得

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

GET /projects/:id/integrations/confluence

志茂インテグレーション

内部WikiへのリンクをShimoワークスペースへのリンクに置き換えます。

Shimoインテグレーションを作成/編集

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

PUT /projects/:id/integrations/shimo

パラメータを指定します：

パラメータ種類必須説明
external_wiki_url文字列です。true志茂ワークスペースURL

Shimoインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/shimo

外部Wiki

内部Wikiへのリンクを外部Wikiへのリンクに置き換えます。

作成/編集 外部Wikiインテグレーション

プロジェクトに外部Wikiインテグレーションを設定します。

PUT /projects/:id/integrations/external-wiki

パラメータを指定します：

パラメータ種類必須説明
external_wiki_url文字列です。true外部WikiのURL

外部Wikiインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/external-wiki

外部Wikiインテグレーション設定の取得

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

GET /projects/:id/integrations/external-wiki

GitHub

コードコラボレーションソフトウェア。

作成/編集 GitHubインテグレーション

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

PUT /projects/:id/integrations/github

パラメータを指定します：

パラメータ種類必須説明
token文字列です。trueGitHub API トークン (repo:status OAuth スコープ付き)
repository_url文字列です。trueGitHubリポジトリURL
static_contextbooleanfalse ステータスチェック名にブランチではなくインスタンス名を追加

GitHub インテグレーションを無効化

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

DELETE /projects/:id/integrations/github

GitHub インテグレーション設定の取得

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

GET /projects/:id/integrations/github

ハングアウトチャット

Google Workspaceのチームコラボレーションツール。

ハングアウトチャットの作成/編集インテグレーション

プロジェクトにHangoutsチャットインテグレーションを設定します。

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

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。trueハングアウトチャットWebhook。例えば、https://chat.googleapis.com/v1/spaces....
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信
notify_only_default_branchbooleanfalse廃止されました：このパラメータはbranches_to_be_notified
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
note_eventsbooleanfalseノートイベントの通知を有効にします。
confidential_note_eventsbooleanfalse秘密メモイベントの通知を有効にします。
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。

ハングアウト・チャット・インテグレーションを無効にします。

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

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

ハングアウトチャット インテグレーション設定を取得

プロジェクトのハングアウトチャットインテグレーション設定を取得します。

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

Irker (IRC ゲートウェイ)

irkerゲートウェイを経由して、受信者リストにIRCメッセージを送信します。

詳しくはirkerインテグレーションドキュメントを参照してください。

Irker (IRC ゲートウェイ) インテグレーションの作成/編集

プロジェクトのIrker（IRCゲートウェイ）インテグレーションを設定します。

PUT /projects/:id/integrations/irker

パラメータを指定します：

パラメータ種類必須説明
recipients文字列です。true空白で区切られた受信者/チャンネル
default_irc_uri文字列です。falseirc://irc.network.net:6697/
server_host文字列です。falseローカルホスト
server_port整数。false6659
colorize_messagesbooleanfalseメッセージのカラー化

Irker（IRCゲートウェイ）インテグレーションを無効化

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

DELETE /projects/:id/integrations/irker

Irker（IRCゲートウェイ）インテグレーション設定の取得

プロジェクトの Irker (IRC ゲートウェイ) インテグレーション設定を取得します。

GET /projects/:id/integrations/irker

Jira

Jiraイシュー・トラッカー。

Jira インテグレーション設定の取得

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

GET /projects/:id/integrations/jira

Jira インテグレーションの作成/編集

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

PUT /projects/:id/integrations/jira

パラメータを指定します：

パラメータ種類必須説明
url文字列です。yesGitLab プロジェクトにリンクされている 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文字列です。yesJira で使用する Jira API トークン、パスワード、または個人アクセストークン。認証方法が基本 (jira_auth_type は0) の場合、Jira Cloud には API トークン、Jira Data Center または Jira Server にはパスワードを使用します。認証方法が Jira パーソナル アクセストークン (jira_auth_type は1) の場合、パーソナル アクセストークンを使用します。
activebooleanいいえインテグレーションをアクティブまたは非アクティブにします。デフォルトはfalse (無効) です。
jira_auth_type整数。いいえJira で使用する認証方法。0 は基本認証を意味します。1 は Jira パーソナル アクセストークンを意味します。デフォルトは0 です。
jira_issue_prefix文字列です。いいえJiraイシューのキーにマッチするプレフィックス。
jira_issue_regex文字列です。いいえJira イシューのキーにマッチする正規表現。
jira_issue_transition_automaticbooleanいいえ 自動イシュー遷移を有効にします。有効にすると、jira_issue_transition_id より優先されます。デフォルトはfalse
jira_issue_transition_id文字列です。いいえ カスタムissue遷移の1つまたは複数の遷移のID。jira_issue_transition_automatic が有効な場合は無視されます。デフォルトは空白文字列で、カスタム・トランジションは無効になります。
commit_eventsbooleanfalseコミットイベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
comment_on_event_enabledbooleanfalseGitLab の各イベント (コミット / マージリクエスト) で Jira イシュー内のコメントを有効にします。

Jiraインテグレーションを無効化

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

DELETE /projects/:id/integrations/jira

Slack スラッシュ コマンド

Slackチャットインスタンスからスラッシュコマンドを受信する機能。

Slackスラッシュコマンドのインテグレーション設定の取得

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

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,
  "properties": {
    "token": "<your_access_token>"
  }
}

Slackスラッシュコマンドの作成/編集インテグレーション

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

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

パラメータを指定します：

パラメータ種類必須説明
token文字列です。yesSlackトークン

Slackスラッシュコマンドのインテグレーションを無効にします。

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

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

Mattermost スラッシュコマンド

Mattermost チャットインスタンスからスラッシュコマンドを受信する機能。

Mattermost スラッシュコマンドのインテグレーション設定を取得

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

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

Mattermost Slash Command インテグレーションの作成/編集

プロジェクトに Mattermost Slash Command を設定します。

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

パラメータを指定します：

パラメータ種類必須説明
token文字列です。yesMattermostトークン

Mattermost Slash Commandインテグレーションを無効にします。

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

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

Packagist

コミットやタグがGitLabにプッシュされると、Packagist（Composerのメインリポジトリ）上のプロジェクトを更新します。

Packagistインテグレーションを作成/編集

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

PUT /projects/:id/integrations/packagist

パラメータを指定します：

パラメータ種類必須説明
username文字列です。yesPackagist アカウントのユーザー名
token文字列です。yesPackagistサーバへのAPIトークン
serverbooleanいいえPackagistサーバのURL。デフォルトは空白です：https://packagist.org
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。

Packagistインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/packagist

Packagistインテグレーション設定の取得

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

GET /projects/:id/integrations/packagist

パイプラインメール

GitLab CI/CDパイプラインのメールを取得します。

パイプラインとメールのインテグレーションを作成/編集

プロジェクトにパイプラインとメールのインテグレーションを設定します。

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

パラメータを指定します：

パラメータ種類必須説明
recipients文字列です。yes受信者メールアドレスのカンマ区切りリスト
notify_only_broken_pipelinesbooleanいいえ破損したパイプラインのみ通知
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
notify_only_default_branchbooleanいいえデフォルトブランチに対してのみ通知を送信(GitLab 12.0 で導入)
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。

パイプラインとメールのインテグレーションを無効にします。

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

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

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

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

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

Pivotal Tracker

Pivotal Trackerのストーリーにコメントとしてコミットメッセージを追加します。

Pivotal Trackerインテグレーションドキュメントも参照してください。

Pivotal Trackerインテグレーションを作成/編集

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

PUT /projects/:id/integrations/pivotaltracker

パラメータを指定します：

パラメータ種類必須説明
token文字列です。truePivotal Trackerトークン
restrict_to_branchbooleanfalse自動的に検査するブランチのコンマ区切りリスト。すべてのブランチを含める場合は空白にしてください。

Pivotal Trackerインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/pivotaltracker

Pivotal Trackerのインテグレーション設定を取得します。

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

GET /projects/:id/integrations/pivotaltracker

Prometheus

Prometheusは強力な時系列モニタリングサービスです。

Prometheusインテグレーションの作成/編集

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

PUT /projects/:id/integrations/prometheus

パラメータを指定します：

パラメータ種類必須説明
api_url文字列です。truePrometheus APIベースURL。例えば、http://prometheus.example.com/.
google_iap_audience_client_id文字列です。falseIAP セキュアリソースのクライアント ID (IAP_CLIENT_ID.apps.googleusercontent.com のようなもの)
google_iap_service_account_json文字列です。false credentials.json のように、サービスアカウント用の"type": "service_account", "project_id": ... }

Prometheusインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/prometheus

Prometheusインテグレーション設定の取得

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

GET /projects/:id/integrations/prometheus

プッシュオーバー

Pushoverを使えば、Androidデバイス、iPhone、iPad、デスクトップでリアルタイム通知を簡単に受け取ることができます。

Pushoverインテグレーションを作成/編集

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

PUT /projects/:id/integrations/pushover

パラメータを指定します：

パラメータ種類必須説明
api_key文字列です。trueアプリケーションキー
user_key文字列です。trueユーザーキー
priority文字列です。true優先順位
device文字列です。falseすべてのアクティビティデバイスの場合は空白にします。
sound文字列です。false通知音

Pushoverインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/pushover

Pushoverインテグレーション設定の取得

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

GET /projects/:id/integrations/pushover

Redmine

Redmine イシュー・トラッカー

Redmineインテグレーションを作成/編集

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

PUT /projects/:id/integrations/redmine

パラメータを指定します：

パラメータ種類必須説明
new_issue_url文字列です。true新しいイシューのURL
project_url文字列です。trueプロジェクトの URL
issues_url文字列です。trueイシューURL

Redmineインテグレーションを無効化

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

DELETE /projects/:id/integrations/redmine

Redmineインテグレーション設定の取得

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

GET /projects/:id/integrations/redmine

Slackの通知

Slackでイベント通知を受信

Slackインテグレーションを作成/編集

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

PUT /projects/:id/integrations/slack

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。truehttps://hooks.slack.com/services/...
username文字列です。falseユーザー名
channel文字列です。false他のチャンネルが設定されていない場合に使用するデフォルトチャンネル
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信
notify_only_default_branchbooleanfalse廃止されました：このパラメータはbranches_to_be_notified
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
alert_channel文字列です。falseアラートイベント通知を受け取るチャンネル名
alert_eventsbooleanfalseアラートイベントの通知を有効にします。
commit_eventsbooleanfalseコミットイベントの通知を有効にします。
confidential_issue_channel文字列です。false機密イシューイベント通知を受け取るチャネル名
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
confidential_note_channel文字列です。false機密メモイベント通知を受け取るチャンネル名
confidential_note_eventsbooleanfalse秘密メモイベントの通知を有効にします。
deployment_channel文字列です。falseデプロイイベントの通知を受け取るチャンネル名
deployment_eventsbooleanfalseデプロイイベントの通知を有効にします。
incident_channel文字列です。falseインシデントイベント通知を受け取るチャンネル名
incidents_eventsbooleanfalseインシデントイベントの通知を有効にします。
issue_channel文字列です。falseイシューイベント通知を受け取るチャネル名
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
job_eventsbooleanfalseジョブイベントの通知を有効にします。
merge_request_channel文字列です。falseマージリクエストイベントの通知を受け取るチャネルの名前。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
note_channel文字列です。falseノートイベントの通知を受け取るチャンネル名
note_eventsbooleanfalseノートイベントの通知を有効にします。
pipeline_channel文字列です。falseパイプラインイベントの通知を受け取るチャンネル名
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
push_channel文字列です。falseプッシュイベント通知を受け取るチャンネル名
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
tag_push_channel文字列です。falseタグプッシュイベント通知を受け取るチャンネル名
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
wiki_page_channel文字列です。falseWikiページイベントの通知を受け取るチャネルの名前
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。

Slackインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/slack

Slackインテグレーション設定の取得

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

GET /projects/:id/integrations/slack

Microsoft Teams

グループチャットソフトウェア

Microsoft Teamsインテグレーションを作成/編集

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

PUT /projects/:id/integrations/microsoft-teams

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。trueMicrosoft Teams Webhook。例えばhttps://outlook.office.com/webhook/...
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信
notify_only_default_branchbooleanfalse廃止されました：このパラメータはbranches_to_be_notified
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
note_eventsbooleanfalseノートイベントの通知を有効にします。
confidential_note_eventsbooleanfalse秘密メモイベントの通知を有効にします。
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。

Microsoft Teamsインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/microsoft-teams

Microsoft Teamsインテグレーション設定の取得

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

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

Mattermostの通知

Mattermostでイベント通知を受け取ります。

Mattermost 通知インテグレーションを作成/編集

プロジェクトに Mattermost 通知インテグレーションを設定します。

PUT /projects/:id/integrations/mattermost

パラメータを指定します：

パラメータ種類必須説明
webhook文字列です。trueMattermost Webhook。例えばhttp://mattermost_host/hooks/...
username文字列です。falseユーザー名
channel文字列です。false他のチャンネルが設定されていない場合に使用するデフォルトチャンネル
notify_only_broken_pipelinesbooleanfalse壊れたパイプラインの通知を送信
notify_only_default_branchbooleanfalse廃止されました：このパラメータはbranches_to_be_notified
branches_to_be_notified文字列です。false通知を送信するブランチ。有効なオプションはall,default,protected, およびdefault_and_protectedです。デフォルト値は “default” です。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
issues_eventsbooleanfalseイシュー・イベントの通知を有効にします。
confidential_issues_eventsbooleanfalse機密イシュー・イベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。
note_eventsbooleanfalseノートイベントの通知を有効にします。
confidential_note_eventsbooleanfalse秘密メモイベントの通知を有効にします。
pipeline_eventsbooleanfalseパイプラインイベントの通知を有効にします。
wiki_page_eventsbooleanfalseWikiページイベントの通知を有効にします。
push_channel文字列です。falseプッシュイベント通知を受け取るチャンネル名
issue_channel文字列です。falseイシューイベント通知を受け取るチャネル名
confidential_issue_channel文字列です。false機密イシューイベント通知を受け取るチャネル名
merge_request_channel文字列です。falseマージリクエストイベントの通知を受け取るチャネルの名前。
note_channel文字列です。falseノートイベントの通知を受け取るチャンネル名
confidential_note_channel文字列です。false機密メモイベント通知を受け取るチャンネル名
tag_push_channel文字列です。falseタグプッシュイベント通知を受け取るチャンネル名
pipeline_channel文字列です。falseパイプラインイベントの通知を受け取るチャンネル名
wiki_page_channel文字列です。falseWikiページイベントの通知を受け取るチャネルの名前

Mattermost 通知インテグレーションを無効にします。

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

DELETE /projects/:id/integrations/mattermost

Mattermost 通知インテグレーション設定を取得

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

GET /projects/:id/integrations/mattermost

JetBrains TeamCity CI

継続的インテグレーション・ビルドサーバー

JetBrains TeamCity CIインテグレーションの作成/編集

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

TeamCity のビルド設定は、ビルド形式番号%build.vcs.number%を使用する必要があります。マージリクエストがビルドされるように、すべてのブランチの監視を設定します。この設定は VSC ルートの詳細設定にあります。

PUT /projects/:id/integrations/teamcity

パラメータを指定します：

パラメータ種類必須説明
teamcity_url文字列です。trueTeamCity ルート URL。たとえばhttps://teamcity.example.com
enable_ssl_verificationbooleanfalseSSL検証を有効にします。デフォルトはtrue（有効）です。
build_type文字列です。trueビルド設定ID
username文字列です。true手動ビルドを起動する権限を持つユーザー
password文字列です。trueユーザーのパスワード
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。

JetBrains TeamCity CIインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/teamcity

JetBrains TeamCity CI インテグレーション設定の取得

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

GET /projects/:id/integrations/teamcity

Jenkins CI

継続的インテグレーション・ビルドサーバー

Jenkins CIインテグレーションを作成/編集

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

PUT /projects/:id/integrations/jenkins

パラメータを指定します：

パラメータ種類必須説明
jenkins_url文字列です。trueのようなJenkins URLhttp://jenkins.example.com.
enable_ssl_verificationbooleanfalseSSL検証を有効にします。デフォルトはtrue（有効）です。
project_name文字列です。trueURL フレンドリーなプロジェクト名。例:my_project_name.
username文字列です。falseJenkinsサーバで認証が必要な場合のユーザ名。
password文字列です。falseJenkinsサーバで認証が必要な場合のパスワード。
push_eventsbooleanfalseプッシュイベントの通知を有効にします。
merge_requests_eventsbooleanfalseマージリクエストイベントの通知を有効にします。
tag_push_eventsbooleanfalseタグプッシュイベントの通知を有効にします。

Jenkins CIインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/jenkins

Jenkins CIインテグレーション設定の取得

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

GET /projects/:id/integrations/jenkins

Jenkins CI（非推奨）インテグレーション

継続的インテグレーション・ビルドサーバー

note
このインテグレーションはGitLab 13.0で削除されました。

JenkinsCIの作成/編集（非推奨）インテグレーション

プロジェクトにJenkins CI (Deprecated)インテグレーションを設定します。

PUT /projects/:id/integrations/jenkins-deprecated

パラメータを指定します：

  • project_url (必須) - JenkinsプロジェクトのURL。http://jenkins.example.com/job/my-project/
  • multiproject_enabled (オプション) - Jenkins GitLab Hook プラグインでマルチプロジェクトモードが設定されている場合。
  • pass_unstable (オプション) - 不安定なビルドは

Jenkins CI（非推奨）インテグレーションを無効にします。

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

DELETE /projects/:id/integrations/jenkins-deprecated

Jenkins CI (Deprecated) のインテグレーション設定を取得します。

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

GET /projects/:id/integrations/jenkins-deprecated

モックCI

外部のCIをモックします。コンパニオンモックのインテグレーション例はgitlab-org/gitlab-mock-ci-service を参照してください。

このインテグレーションは環境が開発者に設定されている場合のみ利用可能です。

MockCIインテグレーションの作成/編集

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

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

パラメータを指定します：

パラメータ種類必須説明
mock_service_url文字列です。truehttp://localhost:4004
enable_ssl_verificationbooleanfalseSSL検証を有効にします。デフォルトはtrue（有効）です。

MockCIインテグレーションを無効にします。

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

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

MockCIインテグレーション設定の取得

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

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

スカッシュTM

GitLab 15.10 で導入されました。

GitLab イシューの変更時にSquash TM の要件を更新します。

Squash TMインテグレーションを作成/編集します。

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

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

パラメータを指定します：

パラメータ種類必須説明
url文字列です。yesSquash TM WebhookのURL。
token文字列です。いいえオプションのトークン

Squash TMインテグレーションを無効にします。

プロジェクトのSquash TMインテグレーションを無効にします。インテグレーション設定は保持されます。

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

Squash TMインテグレーション設定の取得

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

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

YouTrack

イシュー・トラッカー YouTrack

YouTrackインテグレーションを作成/編集

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

PUT /projects/:id/integrations/youtrack

パラメータを指定します：

パラメータ種類必須説明
issues_url文字列です。trueイシューURL
project_url文字列です。trueプロジェクトの URL

YouTrackインテグレーションを無効にします。

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

DELETE /projects/:id/integrations/youtrack

YouTrackインテグレーション設定を取得

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

GET /projects/:id/integrations/youtrack