サービスAPI

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

アクティビティ一覧

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

すべてのアクティブなプロジェクトサービスのリストを取得します。 

GET /projects/:id/services

回答例 

[
  {
    "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,
    "confidential_issues_events": true,
    "merge_requests_events": true,
    "tag_push_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,
    "confidential_issues_events": true,
    "merge_requests_events": true,
    "tag_push_events": true,
    "note_events": true,
    "confidential_note_events": true,
    "pipeline_events": true,
    "wiki_page_events": true,
    "job_events": true,
    "comment_on_event_enabled": true
  }
]

アサナ

Asana - Eメールを使わないチームワーク

Asanaサービスの作成/編集

プロジェクトに Asana サービスを設定します。

このサービスはコミットメッセージをコメントとして Asana タスクに追加します。 有効にすると、コミットメッセージは Asana タスクの URL (例:https://app.asana.com/0/123456/987654) または # で始まるタスク ID (例:#987654) がチェックされます。見つかったタスク ID にはすべてコミットコメントが追加されます。また、以下のコンテナを含むメッセージでタスクを閉じることもできます:fix #123456. API キーはこちらで確認できます:https://developers.asana.com/docs/#authentication-basics. 

PUT /projects/:id/services/asana

パラメーター

パラメータ タイプ 必須 説明
api_key 列 真の ユーザーAPIトークン。 ユーザーはタスクにアクセストークンする必要があり、すべてのコメントはこのユーザーに帰属します。
restrict_to_branch 列 false 自動的に検査されるブランチのカンマ区切りリスト。 すべてのブランチを含めるには空白にしてください。
push_events ブーリアン false プッシュイベントの通知を有効にします。

Asanaサービスの削除

プロジェクトの Asana サービスを削除します。 

DELETE /projects/:id/services/asana

Asanaサービス設定の取得

プロジェクトの Asana サービス設定を取得します。 

GET /projects/:id/services/asana

アッセンブラ

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

アセンブラサービスの作成/編集

プロジェクトに Assembla サービスを設定します。 

PUT /projects/:id/services/assembla

パラメーター

パラメータ タイプ 必須 説明
token 列 真の 認証トークン
subdomain 列 false サブドメインの設定
push_events ブーリアン false プッシュイベントの通知を有効にします。

Assemblaサービスの削除

プロジェクトの Assembla サービスを削除します。 

DELETE /projects/:id/services/assembla

Assembla サービス設定の取得

プロジェクトの Assembla サービス設定を取得します。 

GET /projects/:id/services/assembla

アトラシアン Bamboo CI

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

Atlassian Bamboo CI サービスの作成/編集

プロジェクトに Atlassian Bamboo CI サービスを設定します。

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

PUT /projects/:id/services/bamboo

パラメーター

パラメータ タイプ 必須 説明
bamboo_url 列 真の 例えば、https://bamboo.example.com.
build_key 列 真の KEYのようなバンブービルドプランキー
username 列 真の 該当する場合は、APIアクセス権を持つユーザー
password 列 真の ユーザーのパスワード
push_events ブーリアン false プッシュイベントの通知を有効にします。

Atlassian Bamboo CI サービスを削除

プロジェクトの Atlassian Bamboo CI サービスを削除します。 

DELETE /projects/:id/services/bamboo

Atlassian Bamboo CI サービスの設定を取得

プロジェクトの Atlassian Bamboo CI サービス設定を取得します。 

GET /projects/:id/services/bamboo

Bugzilla

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

Bugzillaサービスの作成/編集

プロジェクトにBugzillaサービスを設定します。 

PUT /projects/:id/services/bugzilla

パラメーター

パラメータ タイプ 必須 説明
new_issue_url 列 真の 新着イシューURL
issues_url 列 真の イシューURL
project_url 列 真の プロジェクトURL
description 列 false 説明
title 列 false タイトル
push_events ブーリアン false プッシュイベントの通知を有効にします。

Bugzilla サービスの削除

プロジェクトの Bugzilla サービスを削除します。 

DELETE /projects/:id/services/bugzilla

Bugzillaサービス設定の取得

プロジェクトの Bugzilla サービス設定を取得します。 

GET /projects/:id/services/bugzilla

ビルドカイト

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

Buildkiteサービスの作成/編集

プロジェクトにBuildkiteサービスを設定します。 

PUT /projects/:id/services/buildkite

パラメーター

パラメータ タイプ 必須 説明
token 列 真の Buildkiteプロジェクト GitLabトークン
project_url 列 真の https://buildkite.com/example/project
enable_ssl_verification ブーリアン false SSL検証の有効化
push_events ブーリアン false プッシュイベントの通知を有効にします。

Buildkiteサービスの削除

プロジェクトのBuildkiteサービスを削除します。 

DELETE /projects/:id/services/buildkite

Buildkiteサービス設定の取得

プロジェクトのBuildkiteサービス設定を取得します。 

GET /projects/:id/services/buildkite

キャンプファイヤー

シンプルなウェブベースのリアルタイムグループチャット

キャンプファイヤーサービスの作成/編集

プロジェクトにキャンプファイヤーサービスを設定します。 

PUT /projects/:id/services/campfire

パラメーター

パラメータ タイプ 必須 説明
token 列 真の キャンプファイヤートークン
subdomain 列 false キャンプファイヤーのサブドメイン
room 列 false キャンプファイヤー・ルーム
push_events ブーリアン false プッシュイベントの通知を有効にします。

キャンプファイヤーサービスの削除

プロジェクトのCampfireサービスを削除します。 

DELETE /projects/:id/services/campfire

Campfireのサービス設定

プロジェクト用のCampfireサービス設定を取得します。 

GET /projects/:id/services/campfire

ユニファイサーキット

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

Unify 回路サービスの作成/編集

プロジェクトに Unify Circuit サービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
webhook 列 真の Unify Circuit webhook。例えば、https://circuit.com/rest/v2/webhooks/incoming/...。
notify_only_broken_pipelines ブーリアン false パイプラインの破損に関する通知の送信
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected” および “default_and_protected” です。
push_events ブーリアン false プッシュイベントの通知を有効にします。
issues_events ブーリアン false イシュー・イベントの通知を有効にします。
confidential_issues_events ブーリアン false 機密イシューイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
note_events ブーリアン false ノートイベントの通知を有効にします。
confidential_note_events ブーリアン false 機密メモイベントの通知を有効にします。
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。
wiki_page_events ブーリアン false wikiページのイベント通知を有効にします。

Unify Circuit サービスの削除

プロジェクトの Unify Circuit サービスを削除します。 

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

Unify Circuit サービス設定の取得

プロジェクトの Unify Circuit サービス設定を取得します。 

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

Webex チーム

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

Webex Teamsサービスの作成/編集

プロジェクトに Webex Teams サービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
webhook 列 真の Webex Teams の webhook。例えば、https://api.ciscospark.com/v1/webhooks/incoming/...。
notify_only_broken_pipelines ブーリアン false パイプラインの破損に関する通知の送信
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected” および “default_and_protected” です。
push_events ブーリアン false プッシュイベントの通知を有効にします。
issues_events ブーリアン false イシュー・イベントの通知を有効にします。
confidential_issues_events ブーリアン false 機密イシューイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
note_events ブーリアン false ノートイベントの通知を有効にします。
confidential_note_events ブーリアン false 機密メモイベントの通知を有効にします。
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。
wiki_page_events ブーリアン false wikiページのイベント通知を有効にします。

Webex Teamsサービスの削除

プロジェクトの Webex Teams サービスを削除します。 

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

Webex Teams サービス設定の取得

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

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

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

カスタム課題管理ツール

カスタムイシュートラッカーサービスの作成/編集

プロジェクトにカスタムイシュートラッカーサービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
new_issue_url 列 真の 新着イシューURL
issues_url 列 真の イシューURL
project_url 列 真の プロジェクトURL
description 列 false 説明
title 列 false タイトル
push_events ブーリアン false プッシュイベントの通知を有効にします。

カスタム課題追跡サービスの削除

プロジェクトのカスタム課題追跡サービスを削除します。 

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

カスタム イシュー トラッカー サービスの設定を取得します。

プロジェクトのカスタム Issue Tracker サービス設定を取得します。 

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

ドローンCI

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

ドローンCIサービスの作成/編集

プロジェクトにDrone CIサービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
token 列 真の ドローンCIプロジェクト専用トークン
drone_url 列 真の http://drone.example.com
enable_ssl_verification ブーリアン false SSL検証の有効化
push_events ブーリアン false プッシュイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化

Drone CIサービスの削除

プロジェクトのDrone CIサービスを削除します。 

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

Drone CIサービスの設定を取得

プロジェクトのDrone CIサービス設定を取得します。 

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

プッシュ時のメール

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

プッシュサービスでのメール作成・編集

プロジェクトのプッシュサービスにメールを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
recipients 列 真の 空白で区切られた電子メール
disable_diffs ブーリアン false コード差分の無効化
send_from_committer_email ブーリアン false コミッターからの送信
push_events ブーリアン false プッシュイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected”、”default_and_protected” です。 タグプッシュに対して常に通知が送信されます。

プッシュ配信メールの削除

プロジェクトのプッシュサービスでメールを削除します。 

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

プッシュサービス設定に関するメールの受信

プロジェクトのプッシュサービス設定に関する電子メールを取得します。 

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

外部ウィキ

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

外部Wikiサービスの作成/編集

プロジェクトに外部Wikiサービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
external_wiki_url 列 真の 外部WikiのURL

外部Wikiサービスの削除

プロジェクトの外部Wikiサービスを削除します。 

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

外部Wikiサービス設定の取得

プロジェクトの外部Wikiサービス設定を取得します。 

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

フロードック

Flowdockは技術チームのためのコラボレーションウェブアプリです。

Flowdockサービスの作成/編集

プロジェクトにFlowdockサービスを設定します。 

PUT /projects/:id/services/flowdock

パラメーター

パラメータ タイプ 必須 説明
token 列 真の Flowdock Gitソース・トークン
push_events ブーリアン false プッシュイベントの通知を有効にします。

Flowdockサービスの削除

プロジェクトのFlowdockサービスを削除します。 

DELETE /projects/:id/services/flowdock

Flowdockサービス設定の取得

プロジェクトのFlowdockサービス設定を取得します。 

GET /projects/:id/services/flowdock

ギットハブ

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

GitHubサービスの作成/編集

プロジェクトにGitHubサービスを設定します。 

PUT /projects/:id/services/github

パラメーター

パラメータ タイプ 必須 説明
token 列 真の GitHub API トークンとrepo:status OAuth スコープ
repository_url 列 真の GitHubリポジトリURL
static_context ブーリアン false ステータスチェック名にブランチではなくインスタンス名を追加

GitHubサービスの削除

プロジェクトの GitHub サービスを削除します。 

DELETE /projects/:id/services/github

GitHub サービスの設定を取得

プロジェクトの GitHub サービス設定を取得します。 

GET /projects/:id/services/github

ハングアウトチャット

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

注：このサービスはv11.2で導入されました。

ハングアウトチャットサービスの作成/編集

プロジェクトにハングアウトチャットサービスを設定します。 

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

注：特定のイベントパラメータ（例えば、push_events フラグ）は、v10.4 で導入されました。

パラメーター

パラメータ タイプ 必須 説明
webhook 列 真の ハングアウト チャット webhook。例えば、https://chat.googleapis.com/v1/spaces...。
notify_only_broken_pipelines ブーリアン false パイプラインの破損に関する通知の送信
notify_only_default_branch ブーリアン false 廃止: このパラメータは次のように置き換えられました。branches_to_be_notified
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected” および “default_and_protected” です。
push_events ブーリアン false プッシュイベントの通知を有効にします。
issues_events ブーリアン false イシュー・イベントの通知を有効にします。
confidential_issues_events ブーリアン false 機密イシューイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
note_events ブーリアン false ノートイベントの通知を有効にします。
confidential_note_events ブーリアン false 機密メモイベントの通知を有効にします。
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。
wiki_page_events ブーリアン false wikiページのイベント通知を有効にします。

ハングアウトチャットサービスの削除

プロジェクトのハングアウトチャットサービスを削除します。 

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

ハングアウトチャットサービス設定の取得

プロジェクトのハングアウトチャットサービス設定を取得します。 

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

HipChat

非公開グループチャットとIM

HipChatサービスの作成/編集

プロジェクトにHipChatサービスを設定します。 

PUT /projects/:id/services/hipchat

パラメーター

パラメータ タイプ 必須 説明
token 列 真の ルームトークン
color 列 false 部屋の色
notify ブーリアン false 通知の有効化
room 列 false 部屋名またはID
api_version 列 false デフォルトは空白のまま (v2)
server 列 false デフォルトは空白のままにしておきます。例えば、https://hipchat.example.com。
push_events ブーリアン false プッシュイベントの通知を有効にします。
issues_events ブーリアン false イシュー・イベントの通知を有効にします。
confidential_issues_events ブーリアン false 機密イシューイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
note_events ブーリアン false ノートイベントの通知を有効にします。
confidental_note_events ブーリアン false 機密メモイベントの通知を有効にします。
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。

HipChat サービスの削除

プロジェクトの HipChat サービスを削除します。 

DELETE /projects/:id/services/hipchat

HipChatサービス設定の取得

プロジェクトの HipChat サービス設定を取得します。 

GET /projects/:id/services/hipchat

Irker (IRCゲートウェイ)

更新時に、Irkerゲートウェイを通して受信者リストにIRCメッセージを送信します。

Irker（IRCゲートウェイ）サービスの作成/編集

プロジェクトにIrker（IRCゲートウェイ）サービスを設定します。

Irkerは認証を内蔵していないため、ファイアウォールの外でホストしている場合、IRCチャンネルをスパムする脆弱性があります。 悪用を防ぐため、必ずセキュリティで保護されたネットワーク内でデーモンを実行してください。 詳細はhttp://www.catb.org/~esr/irker/security.htmlをご覧ください。
PUT /projects/:id/services/irker

パラメーター

パラメータ タイプ 必須 説明
recipients 列 真の 空白で区切られた受信者/チャンネル
default_irc_uri 列 false irc://irc.network.net:6697/
server_host 列 false ローカルホスト
server_port 整数 false 6659
colorize_messages ブーリアン false メッセージのカラー化
push_events ブーリアン false プッシュイベントの通知を有効にします。

Irker (IRC ゲートウェイ) サービスの削除

プロジェクトの Irker (IRC ゲートウェイ) サービスを削除します。 

DELETE /projects/:id/services/irker

Irker（IRCゲートウェイ）サービス設定の取得

プロジェクトの Irker (IRC ゲートウェイ) サービス設定を取得します。 

GET /projects/:id/services/irker

Jira

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

Jira サービス設定の取得

プロジェクトの Jira サービス設定を取得します。 

GET /projects/:id/services/jira

Jira サービスの作成/編集

プロジェクトに Jira サービスを設定します。

GitLab 8.14から、api_url、issues_url、new_issue_url 、project_url は、urlに置き換えられています。古いバージョンを使っている場合は、このドキュメントに従ってください。 

PUT /projects/:id/services/jira

パラメーター

パラメータ タイプ 必須 説明
url 列 はい この GitLab プロジェクトにリンクされている Jira プロジェクトの URL。 例えば、https://jira.example.com.
api_url 列 いいえ Jira インスタンス API へのベース URL。設定されていない場合、Web URL 値が使用されます。 インスタンスンスンス、https://jira-api.example.com.
username 列 はい GitLab/Jira で使用するために作成されたユーザーのユーザー名。
password 列 はい GitLab/Jira で使用するために作成されたユーザーのパスワード。
active ブーリアン いいえ サービスをアクティブまたは非アクティブにします。 デフォルトはfalse（非アクティブ）です。
jira_issue_transition_id 列 いいえ issueをクローズ状態に移行させるトランジションのIDです。 この番号は、Jiraワークフロー管理(管理 >イシュー> ワークフロー) で、プロジェクトの目的のワークフローの [オペレーション]の [表示] を選択して確認できます。 各状態のIDは、トランジション (id)列の各トランジション名の括弧内部で確認できます。デフォルトでは、このIDは2に設定されています。
commit_events ブーリアン false コミットイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
comment_on_event_enabled ブーリアン false GitLab の各イベント (コミット / マージリクエスト) で Jira イシュー内のコメントを有効にします。

Jira サービスの削除

プロジェクトから以前の Jira 設定をすべて削除します。 

DELETE /projects/:id/services/jira

Slackのスラッシュコマンド

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

Slackスラッシュコマンドのサービス設定を取得

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

GET /projects/:id/services/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/services/slack-slash-commands

パラメーター

パラメータ タイプ 必須 説明
token 列 はい Slackトークン

Slackスラッシュコマンドサービスの削除

プロジェクトのSlackスラッシュコマンドサービスを削除します。 

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

Mattermostのスラッシュコマンド

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

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

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

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

Mattermostスラッシュ・コマンド・サービスの作成/編集

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

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

パラメーター

パラメータ タイプ 必須 説明
token 列 はい マターモスト・トークン
username 列 いいえ メッセージの投稿に使用するユーザー名

マターモストスラッシュコマンドサービスの削除

プロジェクトのマターモストスラッシュコマンドサービスを削除します。 

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

パッカジスト

コミットやタグがGitLabにプッシュされたら、Packagist（Composerのメインリポジトリ）のプロジェクトを更新してください。

Packagistサービスの作成/編集

プロジェクトにPackagistサービスを設定します。 

PUT /projects/:id/services/packagist

パラメーター

パラメータ タイプ 必須 説明
username 列 はい Packagist アカウントのユーザー名
token 列 はい PackagistサーバへのAPIトークン
server ブーリアン いいえ PackagistサーバのURLです。 デフォルトでは空白のままにしておいてください：https://packagist.org
push_events ブーリアン false プッシュイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化

Packagistサービスの削除

プロジェクトのPackagistサービスを削除します。 

DELETE /projects/:id/services/packagist

Packagistサービス設定の取得

プロジェクトのPackagistサービス設定を取得します。 

GET /projects/:id/services/packagist

パイプライン-Eメール

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

パイプライン・メール・サービスの作成/編集

プロジェクトにパイプラインメールサービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
recipients 列 はい 受信者メールアドレスのカンマ区切りリスト
add_pusher ブーリアン いいえ プッシャーを受信者リストに追加
notify_only_broken_pipelines ブーリアン いいえ 破損したパイプラインのみ通知
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected” および “default_and_protected” です。
notify_only_default_branch ブーリアン いいえ デフォルトブランチのみに通知を送信(GitLab12.0 で導入)
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。

パイプラインメールサービスの削除

プロジェクトのパイプラインメールサービスを削除します。 

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

パイプラインメールサービス設定の取得

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

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

ピボタルトラッカー

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

PivotalTrackerサービスの作成/編集

プロジェクトにPivotalTrackerサービスを設定します。 

PUT /projects/:id/services/pivotaltracker

パラメーター

パラメータ タイプ 必須 説明
token 列 真の PivotalTracker トークン
restrict_to_branch ブーリアン false 自動的に検査されるブランチのカンマ区切りリスト。 すべてのブランチを含めるには空白にしてください。
push_events ブーリアン false プッシュイベントの通知を有効にします。

PivotalTrackerサービスの削除

プロジェクトの PivotalTracker サービスを削除します。 

DELETE /projects/:id/services/pivotaltracker

PivotalTrackerサービス設定の取得

プロジェクトのPivotalTrackerサービス設定を取得します。 

GET /projects/:id/services/pivotaltracker

Prometheus

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

Prometheusサービスの作成/編集

プロジェクトにPrometheusサービスを設定します。 

PUT /projects/:id/services/prometheus

パラメーター

パラメータ タイプ 必須 説明
api_url 列 真の Prometheus API Base URL。例えば、http://prometheus.example.com/.
google_iap_audience_client_id 列 false IAPで保護されたリソースのクライアントID（IAP_CLIENT_ID.apps.googleusercontent.comのようなもの）。
google_iap_service_account_json 列 false credentials.json ファイルのようなものです。

Prometheus サービスの削除

プロジェクトのPrometheusサービスを削除します。 

DELETE /projects/:id/services/prometheus

Prometheus サービス設定の取得

プロジェクトの Prometheus サービス設定を取得します。 

GET /projects/:id/services/prometheus

プッシュオーバー

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

Pushoverサービスの作成/編集

プロジェクトにPushoverサービスを設定します。 

PUT /projects/:id/services/pushover

パラメーター

パラメータ タイプ 必須 説明
api_key 列 真の アプリケーションキー
user_key 列 真の ユーザーキー
priority 列 真の 優先順位
device 列 false すべてのアクティビティデバイスの場合は空白のままにしてください。
sound 列 false 通知音
push_events ブーリアン false プッシュイベントの通知を有効にします。

Pushoverサービスの削除

プロジェクトのPushoverサービスを削除します。 

DELETE /projects/:id/services/pushover

Pushoverサービス設定の取得

プロジェクトのPushoverサービス設定を取得します。 

GET /projects/:id/services/pushover

Redmine

Redmine イシュー・トラッカー

Redmineサービスの作成/編集

プロジェクトにRedmineサービスを設定します。 

PUT /projects/:id/services/redmine

パラメーター

パラメータ タイプ 必須 説明
new_issue_url 列 真の 新着イシューURL
project_url 列 真の プロジェクトURL
issues_url 列 真の イシューURL
description 列 false 説明
push_events ブーリアン false プッシュイベントの通知を有効にします。

Redmineサービスの削除

プロジェクトのRedmineサービスを削除します。 

DELETE /projects/:id/services/redmine

Redmineサービス設定の取得

プロジェクトのRedmineサービス設定を取得します。 

GET /projects/:id/services/redmine

Slackの通知

Slackでイベント通知を受信

Slackサービスの作成/編集

プロジェクトにSlackサービスを設定します。 

PUT /projects/:id/services/slack

注：特定のイベントパラメータ（例えば、push_events フラグやpush_channel）は、v10.4 で導入されました。

パラメーター

パラメータ タイプ 必須 説明
webhook 列 真の https://hooks.slack.com/services/...
username 列 false ユーザー名
channel 列 false 他のチャンネルが設定されていない場合に使用するデフォルト・チャンネル
notify_only_broken_pipelines ブーリアン false パイプラインの破損に関する通知の送信
notify_only_default_branch ブーリアン false 廃止: このパラメータは次のように置き換えられました。branches_to_be_notified
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected” および “default_and_protected” です。
commit_events ブーリアン false コミットイベントの通知を有効にします。
confidential_issue_channel 列 false 機密イシュー・イベント通知を受け取るチャネル名
confidential_issues_events ブーリアン false 機密イシューイベントの通知を有効にします。
confidential_note_channel 列 false 機密メモイベント通知を受け取るチャンネル名
confidential_note_events ブーリアン false 機密メモイベントの通知を有効にします。
deployment_channel 列 false デプロイイベントの通知を受け取るチャネルの名前。
deployment_events ブーリアン false デプロイイベントの通知を有効にします。
issue_channel 列 false イシュー・イベント通知を受け取るチャネル名
issues_events ブーリアン false イシュー・イベントの通知を有効にします。
job_events ブーリアン false ジョブイベントの通知を有効にします。
merge_request_channel 列 false マージリクエストイベントの通知を受け取るチャネルの名前。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
note_channel 列 false ノートイベントの通知を受け取るチャンネル名
note_events ブーリアン false ノートイベントの通知を有効にします。
pipeline_channel 列 false パイプラインイベントの通知を受け取るチャネルの名前。
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。
push_channel 列 false プッシュイベント通知を受け取るチャンネル名
push_events ブーリアン false プッシュイベントの通知を有効にします。
tag_push_channel 列 false タグプッシュイベント通知を受け取るチャンネル名
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
wiki_page_channel 列 false wikiページのイベント通知を受け取るチャンネルの名前
wiki_page_events ブーリアン false wikiページのイベント通知を有効にします。

Slackサービスの削除

プロジェクトのSlackサービスを削除します。 

DELETE /projects/:id/services/slack

Slackサービス設定の取得

プロジェクトのSlackサービス設定を取得します。 

GET /projects/:id/services/slack

Microsoft Teams

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

Microsoft Teamsサービスの作成/編集

プロジェクトにMicrosoft Teamsサービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
webhook 列 真の 例えば、Microsoft Teamsのwebhookです、https://outlook.office.com/webhook/...
notify_only_broken_pipelines ブーリアン false パイプラインの破損に関する通知の送信
notify_only_default_branch ブーリアン false 廃止: このパラメータは次のように置き換えられました。branches_to_be_notified
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected” および “default_and_protected” です。
push_events ブーリアン false プッシュイベントの通知を有効にします。
issues_events ブーリアン false イシュー・イベントの通知を有効にします。
confidential_issues_events ブーリアン false 機密イシューイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
note_events ブーリアン false ノートイベントの通知を有効にします。
confidential_note_events ブーリアン false 機密メモイベントの通知を有効にします。
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。
wiki_page_events ブーリアン false wikiページのイベント通知を有効にします。

Microsoft Teamsサービスの削除

プロジェクトの Microsoft Teams サービスを削除します。 

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

Microsoft Teamsサービス設定の取得

プロジェクトの Microsoft Teams サービス設定を取得します。 

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

Mattermostの通知

Mattermostでイベント通知を受信

Mattermost 通知サービスの作成/編集

プロジェクトに Mattermost サービスを設定します。 

PUT /projects/:id/services/mattermost

注：特定のイベントパラメータ（例えば、push_events フラグやpush_channel）は、v10.4 で導入されました。

パラメーター

パラメータ タイプ 必須 説明
webhook 列 真の 例えば、Mattermost webhook、http://mattermost_host/hooks/...
username 列 false ユーザー名
channel 列 false 他のチャンネルが設定されていない場合に使用するデフォルト・チャンネル
notify_only_broken_pipelines ブーリアン false パイプラインの破損に関する通知の送信
notify_only_default_branch ブーリアン false 廃止: このパラメータは次のように置き換えられました。branches_to_be_notified
branches_to_be_notified 列 すべて 通知を送信するブランチ。 有効なオプションは “all”、”default”、”protected” および “default_and_protected” です。
push_events ブーリアン false プッシュイベントの通知を有効にします。
issues_events ブーリアン false イシュー・イベントの通知を有効にします。
confidential_issues_events ブーリアン false 機密イシューイベントの通知を有効にします。
merge_requests_events ブーリアン false マージリクエストイベントの通知を有効にします。
tag_push_events ブーリアン false タグプッシュイベントの通知を有効化
note_events ブーリアン false ノートイベントの通知を有効にします。
confidential_note_events ブーリアン false 機密メモイベントの通知を有効にします。
pipeline_events ブーリアン false パイプラインイベントの通知を有効にします。
wiki_page_events ブーリアン false wikiページのイベント通知を有効にします。
push_channel 列 false プッシュイベント通知を受け取るチャンネル名
issue_channel 列 false イシュー・イベント通知を受け取るチャネル名
confidential_issue_channel 列 false 機密イシュー・イベント通知を受け取るチャネル名
merge_request_channel 列 false マージリクエストイベントの通知を受け取るチャネルの名前。
note_channel 列 false ノートイベントの通知を受け取るチャンネル名
confidential_note_channel ブーリアン 機密メモイベント通知を受け取るチャンネル名  
tag_push_channel 列 false タグプッシュイベント通知を受け取るチャンネル名
pipeline_channel 列 false パイプラインイベントの通知を受け取るチャネルの名前。
wiki_page_channel 列 false wikiページのイベント通知を受け取るチャンネルの名前

Mattermost 通知サービスの削除

プロジェクトの Mattermost Notifications サービスを削除します。 

DELETE /projects/:id/services/mattermost

Mattermost 通知サービスの設定を取得

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

GET /projects/:id/services/mattermost

JetBrains TeamCity CI

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

JetBrains TeamCity CIサービスの作成/編集

プロジェクトに JetBrains TeamCity CI サービスを設定します。

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

PUT /projects/:id/services/teamcity

パラメーター

パラメータ タイプ 必須 説明
teamcity_url 列 真の TeamCity ルート URL、https://teamcity.example.com
build_type 列 真の ビルド構成ID
username 列 真の 手動ビルドを起動する権限を持つユーザー
password 列 真の ユーザーのパスワード
push_events ブーリアン false プッシュイベントの通知を有効にします。

JetBrains TeamCity CIサービスの削除

プロジェクトの JetBrains TeamCity CI サービスを削除します。 

DELETE /projects/:id/services/teamcity

JetBrains TeamCity CI サービス設定の取得

プロジェクトの JetBrains TeamCity CI サービス設定を取得します。 

GET /projects/:id/services/teamcity

ジェンキンスCI

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

Jenkins CIサービスの作成/編集

プロジェクトにJenkins CIサービスを設定します。 

PUT /projects/:id/services/jenkins

パラメーター

  • jenkins_url(必須) - Jenkins の URLhttp://jenkins.example.com
  • project_name(必須) - URL フレンドリーなプロジェクト名。 例: my_project_name
  • username (オプション) - Jenkinsサーバーにアクセスできるユーザー。
  • password (オプション) - ユーザーのパスワード

Jenkins CIサービスの削除

プロジェクトのJenkins CIサービスを削除します。 

DELETE /projects/:id/services/jenkins

Jenkins CIサービス設定の取得

プロジェクトのJenkins CIサービス設定を取得します。 

GET /projects/:id/services/jenkins

Jenkins CI（非推奨）サービス

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

注意：このサービスはv13.0で削除されました。

Jenkins CI（非推奨）サービスの作成/編集

プロジェクトにJenkins CI (Deprecated) サービスを設定します。 

PUT /projects/:id/services/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/services/jenkins-deprecated

Jenkins CI (Deprecated) サービス設定の取得

プロジェクトのJenkins CI (Deprecated) サービス設定を取得します。 

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

模擬CI

外部のCIをモックします。コンパニオンモックサービスの例はgitlab-org/gitlab-mock-ci-service を参照してください。

このサービスは環境が開発者に設定されている場合のみ利用可能です。

MockCIサービスの作成/編集

プロジェクトにMockCIサービスを設定します。 

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

パラメーター

パラメータ タイプ 必須 説明
mock_service_url 列 真の http://localhost:4004

MockCIサービスの削除

プロジェクトのMockCIサービスを削除します。 

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

MockCIサービス設定の取得

プロジェクトのMockCIサービス設定を取得します。 

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

YouTrack

YouTrack イシュー・トラッカー

YouTrackサービスの作成/編集

プロジェクトにYouTrackサービスを設定します。 

PUT /projects/:id/services/youtrack

パラメーター

パラメータ タイプ 必須 説明
issues_url 列 真の イシューURL
project_url 列 真の プロジェクトURL
description 列 false 説明
push_events ブーリアン false プッシュイベントの通知を有効にします。

YouTrackサービスの削除

プロジェクトのYouTrackサービスを削除します。 

DELETE /projects/:id/services/youtrack

YouTrackサービス設定の取得

プロジェクトのYouTrackサービス設定を取得します。 

GET /projects/:id/services/youtrack