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