# Services API > 原文：[https://docs.gitlab.com/ee/api/services.html](https://docs.gitlab.com/ee/api/services.html) * [List all active services](#list-all-active-services) * [Asana](#asana) * [Create/Edit Asana service](#createedit-asana-service) * [Delete Asana service](#delete-asana-service) * [Get Asana service settings](#get-asana-service-settings) * [Assembla](#assembla) * [Create/Edit Assembla service](#createedit-assembla-service) * [Delete Assembla service](#delete-assembla-service) * [Get Assembla service settings](#get-assembla-service-settings) * [Atlassian Bamboo CI](#atlassian-bamboo-ci) * [Create/Edit Atlassian Bamboo CI service](#createedit-atlassian-bamboo-ci-service) * [Delete Atlassian Bamboo CI service](#delete-atlassian-bamboo-ci-service) * [Get Atlassian Bamboo CI service settings](#get-atlassian-bamboo-ci-service-settings) * [Bugzilla](#bugzilla) * [Create/Edit Bugzilla service](#createedit-bugzilla-service) * [Delete Bugzilla Service](#delete-bugzilla-service) * [Get Bugzilla Service Settings](#get-bugzilla-service-settings) * [Buildkite](#buildkite) * [Create/Edit Buildkite service](#createedit-buildkite-service) * [Delete Buildkite service](#delete-buildkite-service) * [Get Buildkite service settings](#get-buildkite-service-settings) * [Campfire](#campfire) * [Create/Edit Campfire service](#createedit-campfire-service) * [Delete Campfire service](#delete-campfire-service) * [Get Campfire service settings](#get-campfire-service-settings) * [Unify Circuit](#unify-circuit) * [Create/Edit Unify Circuit service](#createedit-unify-circuit-service) * [Delete Unify Circuit service](#delete-unify-circuit-service) * [Get Unify Circuit service settings](#get-unify-circuit-service-settings) * [Webex Teams](#webex-teams) * [Create/Edit Webex Teams service](#createedit-webex-teams-service) * [Delete Webex Teams service](#delete-webex-teams-service) * [Get Webex Teams service settings](#get-webex-teams-service-settings) * [Custom Issue Tracker](#custom-issue-tracker) * [Create/Edit Custom Issue Tracker service](#createedit-custom-issue-tracker-service) * [Delete Custom Issue Tracker service](#delete-custom-issue-tracker-service) * [Get Custom Issue Tracker service settings](#get-custom-issue-tracker-service-settings) * [Drone CI](#drone-ci) * [Create/Edit Drone CI service](#createedit-drone-ci-service) * [Delete Drone CI service](#delete-drone-ci-service) * [Get Drone CI service settings](#get-drone-ci-service-settings) * [Emails on push](#emails-on-push) * [Create/Edit Emails on push service](#createedit-emails-on-push-service) * [Delete Emails on push service](#delete-emails-on-push-service) * [Get Emails on push service settings](#get-emails-on-push-service-settings) * [Confluence service](#confluence-service) * [Create/Edit Confluence service](#createedit-confluence-service) * [Delete Confluence service](#delete-confluence-service) * [Get Confluence service settings](#get-confluence-service-settings) * [External Wiki](#external-wiki) * [Create/Edit External Wiki service](#createedit-external-wiki-service) * [Delete External Wiki service](#delete-external-wiki-service) * [Get External Wiki service settings](#get-external-wiki-service-settings) * [Flowdock](#flowdock) * [Create/Edit Flowdock service](#createedit-flowdock-service) * [Delete Flowdock service](#delete-flowdock-service) * [Get Flowdock service settings](#get-flowdock-service-settings) * [GitHub](#github-premium) * [Create/Edit GitHub service](#createedit-github-service) * [Delete GitHub service](#delete-github-service) * [Get GitHub service settings](#get-github-service-settings) * [Hangouts Chat](#hangouts-chat) * [Create/Edit Hangouts Chat service](#createedit-hangouts-chat-service) * [Delete Hangouts Chat service](#delete-hangouts-chat-service) * [Get Hangouts Chat service settings](#get-hangouts-chat-service-settings) * [HipChat](#hipchat) * [Create/Edit HipChat service](#createedit-hipchat-service) * [Delete HipChat service](#delete-hipchat-service) * [Get HipChat service settings](#get-hipchat-service-settings) * [Irker (IRC gateway)](#irker-irc-gateway) * [Create/Edit Irker (IRC gateway) service](#createedit-irker-irc-gateway-service) * [Delete Irker (IRC gateway) service](#delete-irker-irc-gateway-service) * [Get Irker (IRC gateway) service settings](#get-irker-irc-gateway-service-settings) * [Jira](#jira) * [Get Jira service settings](#get-jira-service-settings) * [Create/Edit Jira service](#createedit-jira-service) * [Delete Jira service](#delete-jira-service) * [Slack slash commands](#slack-slash-commands) * [Get Slack slash command service settings](#get-slack-slash-command-service-settings) * [Create/Edit Slack slash command service](#createedit-slack-slash-command-service) * [Delete Slack slash command service](#delete-slack-slash-command-service) * [Mattermost slash commands](#mattermost-slash-commands) * [Get Mattermost slash command service settings](#get-mattermost-slash-command-service-settings) * [Create/Edit Mattermost slash command service](#createedit-mattermost-slash-command-service) * [Delete Mattermost slash command service](#delete-mattermost-slash-command-service) * [Packagist](#packagist) * [Create/Edit Packagist service](#createedit-packagist-service) * [Delete Packagist service](#delete-packagist-service) * [Get Packagist service settings](#get-packagist-service-settings) * [Pipeline-Emails](#pipeline-emails) * [Create/Edit Pipeline-Emails service](#createedit-pipeline-emails-service) * [Delete Pipeline-Emails service](#delete-pipeline-emails-service) * [Get Pipeline-Emails service settings](#get-pipeline-emails-service-settings) * [PivotalTracker](#pivotaltracker) * [Create/Edit PivotalTracker service](#createedit-pivotaltracker-service) * [Delete PivotalTracker service](#delete-pivotaltracker-service) * [Get PivotalTracker service settings](#get-pivotaltracker-service-settings) * [Prometheus](#prometheus) * [Create/Edit Prometheus service](#createedit-prometheus-service) * [Delete Prometheus service](#delete-prometheus-service) * [Get Prometheus service settings](#get-prometheus-service-settings) * [Pushover](#pushover) * [Create/Edit Pushover service](#createedit-pushover-service) * [Delete Pushover service](#delete-pushover-service) * [Get Pushover service settings](#get-pushover-service-settings) * [Redmine](#redmine) * [Create/Edit Redmine service](#createedit-redmine-service) * [Delete Redmine service](#delete-redmine-service) * [Get Redmine service settings](#get-redmine-service-settings) * [Slack notifications](#slack-notifications) * [Create/Edit Slack service](#createedit-slack-service) * [Delete Slack service](#delete-slack-service) * [Get Slack service settings](#get-slack-service-settings) * [Microsoft Teams](#microsoft-teams) * [Create/Edit Microsoft Teams service](#createedit-microsoft-teams-service) * [Delete Microsoft Teams service](#delete-microsoft-teams-service) * [Get Microsoft Teams service settings](#get-microsoft-teams-service-settings) * [Mattermost notifications](#mattermost-notifications) * [Create/Edit Mattermost notifications service](#createedit-mattermost-notifications-service) * [Delete Mattermost notifications service](#delete-mattermost-notifications-service) * [Get Mattermost notifications service settings](#get-mattermost-notifications-service-settings) * [JetBrains TeamCity CI](#jetbrains-teamcity-ci) * [Create/Edit JetBrains TeamCity CI service](#createedit-jetbrains-teamcity-ci-service) * [Delete JetBrains TeamCity CI service](#delete-jetbrains-teamcity-ci-service) * [Get JetBrains TeamCity CI service settings](#get-jetbrains-teamcity-ci-service-settings) * [Jenkins CI](#jenkins-ci-starter) * [Create/Edit Jenkins CI service](#createedit-jenkins-ci-service) * [Delete Jenkins CI service](#delete-jenkins-ci-service) * [Get Jenkins CI service settings](#get-jenkins-ci-service-settings) * [Jenkins CI (Deprecated) Service](#jenkins-ci-deprecated-service) * [Create/Edit Jenkins CI (Deprecated) service](#createedit-jenkins-ci-deprecated-service) * [Delete Jenkins CI (Deprecated) service](#delete-jenkins-ci-deprecated-service) * [Get Jenkins CI (Deprecated) service settings](#get-jenkins-ci-deprecated-service-settings) * [MockCI](#mockci) * [Create/Edit MockCI service](#createedit-mockci-service) * [Delete MockCI service](#delete-mockci-service) * [Get MockCI service settings](#get-mockci-service-settings) * [YouTrack](#youtrack) * [Create/Edit YouTrack service](#createedit-youtrack-service) * [Delete YouTrack Service](#delete-youtrack-service) * [Get YouTrack Service Settings](#get-youtrack-service-settings) # Services API[](#services-api "Permalink") > **注意：**此 API 需要具有維護者或所有者權限的訪問令牌 ## List all active services[](#list-all-active-services "Permalink") 在 GitLab 12.7 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21330) . 獲取所有活動項目服務的列表. ``` 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[](#asana "Permalink") Asana-無需電子郵件的團隊合作 ### Create/Edit Asana service[](#createedit-asana-service "Permalink") 為項目設置 Asana 服務. > 該服務將提交消息添加為 Asana 任務的注釋. 啟用后，將檢查提交消息中的 Asana 任務 URL（例如`https://app.asana.com/0/123456/987654` ）或以＃開頭的任務 ID（例如`#987654` ）. 找到的每個任務 ID 都會在其中添加提交注釋. 您還可以通過以下消息關閉任務： `fix #123456` . 您可以在以下位置找到您的 API 密鑰： [https](https://developers.asana.com/docs/#authentication-basics) : [//developers.asana.com/docs/#authentication-basics](https://developers.asana.com/docs/#authentication-basics) . ``` PUT /projects/:id/services/asana ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `api_key` | string | true | 用戶 API 令牌. 用戶必須有權訪問任務，所有評論都將歸于該用戶. | | `restrict_to_branch` | string | false | 以逗號分隔的分支列表，將自動對其進行檢查. 保留空白以包括所有分支. | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Asana service[](#delete-asana-service "Permalink") 刪除項目的 Asana 服務. ``` DELETE /projects/:id/services/asana ``` ### Get Asana service settings[](#get-asana-service-settings "Permalink") 獲取項目的 Asana 服務設置. ``` GET /projects/:id/services/asana ``` ## Assembla[](#assembla "Permalink") 項目管理軟件（源提交端點） ### Create/Edit Assembla service[](#createedit-assembla-service "Permalink") 為項目設置 Assembla 服務. ``` PUT /projects/:id/services/assembla ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | 認證令牌 | | `subdomain` | string | false | 子域設置 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Assembla service[](#delete-assembla-service "Permalink") 刪除項目的 Assembla 服務. ``` DELETE /projects/:id/services/assembla ``` ### Get Assembla service settings[](#get-assembla-service-settings "Permalink") 獲取項目的 Assembla 服務設置. ``` GET /projects/:id/services/assembla ``` ## Atlassian Bamboo CI[](#atlassian-bamboo-ci "Permalink") 持續集成和構建服務器 ### Create/Edit Atlassian Bamboo CI service[](#createedit-atlassian-bamboo-ci-service "Permalink") 為項目設置 Atlassian Bamboo CI 服務. > 您必須在 Bamboo 中設置自動修訂標簽和存儲庫觸發器. ``` PUT /projects/:id/services/bamboo ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `bamboo_url` | string | true | 竹根 URL. 例如， `https://bamboo.example.com` . | | `build_key` | string | true | 竹構建計劃密鑰，如 KEY | | `username` | string | true | 具有 API 訪問權限的用戶（如果適用） | | `password` | string | true | 用戶密碼 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Atlassian Bamboo CI service[](#delete-atlassian-bamboo-ci-service "Permalink") 刪除項目的 Atlassian Bamboo CI 服務. ``` DELETE /projects/:id/services/bamboo ``` ### Get Atlassian Bamboo CI service settings[](#get-atlassian-bamboo-ci-service-settings "Permalink") 獲取項目的 Atlassian Bamboo CI 服務設置. ``` GET /projects/:id/services/bamboo ``` ## Bugzilla[](#bugzilla "Permalink") Bugzilla 問題追蹤器 ### Create/Edit Bugzilla service[](#createedit-bugzilla-service "Permalink") 為項目設置 Bugzilla 服務. ``` PUT /projects/:id/services/bugzilla ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `new_issue_url` | string | true | 新發行網址 | | `issues_url` | string | true | 發行網址 | | `project_url` | string | true | 項目網址 | | `description` | string | false | Description | | `title` | string | false | Title | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Bugzilla Service[](#delete-bugzilla-service "Permalink") 刪除項目的 Bugzilla 服務. ``` DELETE /projects/:id/services/bugzilla ``` ### Get Bugzilla Service Settings[](#get-bugzilla-service-settings "Permalink") 獲取項目的 Bugzilla 服務設置. ``` GET /projects/:id/services/bugzilla ``` ## Buildkite[](#buildkite "Permalink") 持續集成和部署 ### Create/Edit Buildkite service[](#createedit-buildkite-service "Permalink") 為項目設置 Buildkite 服務. ``` PUT /projects/:id/services/buildkite ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | Buildkite 項目 GitLab 令牌 | | `project_url` | string | true | `https://buildkite.com/example/project` | | `enable_ssl_verification` | boolean | false | 啟用 S??SL 驗證 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Buildkite service[](#delete-buildkite-service "Permalink") 刪除項目的 Buildkite 服務. ``` DELETE /projects/:id/services/buildkite ``` ### Get Buildkite service settings[](#get-buildkite-service-settings "Permalink") 獲取項目的 Buildkite 服務設置. ``` GET /projects/:id/services/buildkite ``` ## Campfire[](#campfire "Permalink") 基于網絡的簡單實時群聊 ### Create/Edit Campfire service[](#createedit-campfire-service "Permalink") 為項目設置篝火服務. ``` PUT /projects/:id/services/campfire ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | 篝火令牌 | | `subdomain` | string | false | 篝火子域 | | `room` | string | false | 篝火室 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Campfire service[](#delete-campfire-service "Permalink") 刪除項目的 Campfire 服務. ``` DELETE /projects/:id/services/campfire ``` ### Get Campfire service settings[](#get-campfire-service-settings "Permalink") 獲取項目的 Campfire 服務設置. ``` GET /projects/:id/services/campfire ``` ## Unify Circuit[](#unify-circuit "Permalink") 統一電路 RTC 和協作工具. ### Create/Edit Unify Circuit service[](#createedit-unify-circuit-service "Permalink") 為項目設置"統一電路"服務. ``` PUT /projects/:id/services/unify-circuit ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `webhook` | string | true | 統一電路網絡掛鉤. 例如， `https://circuit.com/rest/v2/webhooks/incoming/...` | | `notify_only_broken_pipelines` | boolean | false | 發送有關管道中斷的通知 | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected" | | `push_events` | boolean | false | 啟用推送事件通知 | | `issues_events` | boolean | false | 啟用問題事件通知 | | `confidential_issues_events` | boolean | false | 啟用機密問題事件的通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `note_events` | boolean | false | 啟用筆記事件通知 | | `confidential_note_events` | boolean | false | 啟用機密筆記事件的通知 | | `pipeline_events` | boolean | false | 啟用管道事件通知 | | `wiki_page_events` | boolean | false | 啟用 Wiki 頁面事件的通知 | ### Delete Unify Circuit service[](#delete-unify-circuit-service "Permalink") 刪除項目的統一電路服務. ``` DELETE /projects/:id/services/unify-circuit ``` ### Get Unify Circuit service settings[](#get-unify-circuit-service-settings "Permalink") 獲取項目的統一電路服務設置. ``` GET /projects/:id/services/unify-circuit ``` ## Webex Teams[](#webex-teams "Permalink") Webex Teams 協作工具. ### Create/Edit Webex Teams service[](#createedit-webex-teams-service "Permalink") 為項目設置 Webex Teams 服務. ``` PUT /projects/:id/services/webex-teams ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `webhook` | string | true | Webex Teams Webhook. 例如， `https://api.ciscospark.com/v1/webhooks/incoming/...` | | `notify_only_broken_pipelines` | boolean | false | 發送有關管道中斷的通知 | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected" | | `push_events` | boolean | false | 啟用推送事件通知 | | `issues_events` | boolean | false | 啟用問題事件通知 | | `confidential_issues_events` | boolean | false | 啟用機密問題事件的通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `note_events` | boolean | false | 啟用筆記事件通知 | | `confidential_note_events` | boolean | false | 啟用機密筆記事件的通知 | | `pipeline_events` | boolean | false | 啟用管道事件通知 | | `wiki_page_events` | boolean | false | 啟用 Wiki 頁面事件的通知 | ### Delete Webex Teams service[](#delete-webex-teams-service "Permalink") 刪除項目的 Webex Teams 服務. ``` DELETE /projects/:id/services/webex-teams ``` ### Get Webex Teams service settings[](#get-webex-teams-service-settings "Permalink") 獲取項目的 Webex Teams 服務設置. ``` GET /projects/:id/services/webex-teams ``` ## Custom Issue Tracker[](#custom-issue-tracker "Permalink") 自定義問題跟蹤器 ### Create/Edit Custom Issue Tracker service[](#createedit-custom-issue-tracker-service "Permalink") 為項目設置自定義問題跟蹤服務. ``` PUT /projects/:id/services/custom-issue-tracker ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `new_issue_url` | string | true | 新發行網址 | | `issues_url` | string | true | 發行網址 | | `project_url` | string | true | 項目網址 | | `description` | string | false | Description | | `title` | string | false | Title | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Custom Issue Tracker service[](#delete-custom-issue-tracker-service "Permalink") 刪除項目的自定義問題跟蹤服務. ``` DELETE /projects/:id/services/custom-issue-tracker ``` ### Get Custom Issue Tracker service settings[](#get-custom-issue-tracker-service-settings "Permalink") 獲取項目的自定義問題跟蹤服務設置. ``` GET /projects/:id/services/custom-issue-tracker ``` ## Drone CI[](#drone-ci "Permalink") Drone 是一個基于 Go 編寫的基于 Docker 的持續集成平臺 ### Create/Edit Drone CI service[](#createedit-drone-ci-service "Permalink") 為項目設置 Drone CI 服務. ``` PUT /projects/:id/services/drone-ci ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | 無人機 CI 項目專用令牌 | | `drone_url` | string | true | `http://drone.example.com` | | `enable_ssl_verification` | boolean | false | 啟用 S??SL 驗證 | | `push_events` | boolean | false | 啟用推送事件通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | ### Delete Drone CI service[](#delete-drone-ci-service "Permalink") 刪除項目的 Drone CI 服務. ``` DELETE /projects/:id/services/drone-ci ``` ### Get Drone CI service settings[](#get-drone-ci-service-settings "Permalink") 獲取項目的 Drone CI 服務設置. ``` GET /projects/:id/services/drone-ci ``` ## Emails on push[](#emails-on-push "Permalink") 通過電子郵件將每次推送的提交和差異發送到收件人列表. ### Create/Edit Emails on push service[](#createedit-emails-on-push-service "Permalink") 在項目的推送服務上設置電子郵件. ``` PUT /projects/:id/services/emails-on-push ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `recipients` | string | true | 用空格分隔的電子郵件 | | `disable_diffs` | boolean | false | 禁用代碼差異 | | `send_from_committer_email` | boolean | false | 從提交者發送 | | `push_events` | boolean | false | 啟用推送事件通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected". 推送標簽會始終觸發通知. | ### Delete Emails on push service[](#delete-emails-on-push-service "Permalink") 刪除項目的推送服務電子郵件. ``` DELETE /projects/:id/services/emails-on-push ``` ### Get Emails on push service settings[](#get-emails-on-push-service-settings "Permalink") 獲取有關項目的推送服務設置的電子郵件. ``` GET /projects/:id/services/emails-on-push ``` ## Confluence service[](#confluence-service "Permalink") 版本歷史 * 在 GitLab 13.2 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/220934) . 將到內部 Wiki 的鏈接替換為到 Confluence Cloud Workspace 的鏈接. ### Create/Edit Confluence service[](#createedit-confluence-service "Permalink") 為項目設置 Confluence 服務. ``` PUT /projects/:id/services/confluence ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `confluence_url` | string | true | Confluence Cloud Workspace 的 URL 托管在 atlassian.net 上. | ### Delete Confluence service[](#delete-confluence-service "Permalink") 刪除項目的 Confluence 服務. ``` DELETE /projects/:id/services/confluence ``` ### Get Confluence service settings[](#get-confluence-service-settings "Permalink") 獲取項目的 Confluence 服務設置. ``` GET /projects/:id/services/confluence ``` ## External Wiki[](#external-wiki "Permalink") 將指向內部 Wiki 的鏈接替換為指向外部 Wiki 的鏈接. ### Create/Edit External Wiki service[](#createedit-external-wiki-service "Permalink") 為項目設置外部 Wiki 服務. ``` PUT /projects/:id/services/external-wiki ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `external_wiki_url` | string | true | 外部 Wiki 的 URL | ### Delete External Wiki service[](#delete-external-wiki-service "Permalink") 刪除項目的外部 Wiki 服務. ``` DELETE /projects/:id/services/external-wiki ``` ### Get External Wiki service settings[](#get-external-wiki-service-settings "Permalink") 獲取項目的外部 Wiki 服務設置. ``` GET /projects/:id/services/external-wiki ``` ## Flowdock[](#flowdock "Permalink") Flowdock 是面向技術團隊的協作 Web 應用程序. ### Create/Edit Flowdock service[](#createedit-flowdock-service "Permalink") 為項目設置 Flowdock 服務. ``` PUT /projects/:id/services/flowdock ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | Flowdock Git 源令牌 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Flowdock service[](#delete-flowdock-service "Permalink") 刪除項目的 Flowdock 服務. ``` DELETE /projects/:id/services/flowdock ``` ### Get Flowdock service settings[](#get-flowdock-service-settings "Permalink") 獲取項目的 Flowdock 服務設置. ``` GET /projects/:id/services/flowdock ``` ## GitHub[](#github-premium "Permalink") 代碼協作軟件. ### Create/Edit GitHub service[](#createedit-github-service "Permalink") 為項目設置 GitHub 服務. ``` PUT /projects/:id/services/github ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | 具有`repo:status` OAuth 范圍的 GitHub API 令牌 | | `repository_url` | string | true | GitHub 存儲庫 URL | | `static_context` | boolean | false | 將實例名稱而不是分支附加到[狀態檢查名稱](../user/project/integrations/github.html#static--dynamic-status-check-names) | ### Delete GitHub service[](#delete-github-service "Permalink") 刪除項目的 GitHub 服務. ``` DELETE /projects/:id/services/github ``` ### Get GitHub service settings[](#get-github-service-settings "Permalink") 獲取項目的 GitHub 服務設置. ``` GET /projects/:id/services/github ``` ## Hangouts Chat[](#hangouts-chat "Permalink") Google GSuite 團隊協作工具. > **注意：**此服務是[在 v11.2](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20290)中[引入的](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20290) ### Create/Edit Hangouts Chat service[](#createedit-hangouts-chat-service "Permalink") 為項目設置環聊聊天服務. ``` PUT /projects/:id/services/hangouts-chat ``` > **注意：** [v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)中[引入了](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)特定的事件參數（例如`push_events`標志） Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `webhook` | string | true | Hangouts 即時通訊網路掛鉤. 例如， `https://chat.googleapis.com/v1/spaces...` | | `notify_only_broken_pipelines` | boolean | false | 發送有關管道中斷的通知 | | `notify_only_default_branch` | boolean | false | 已棄用：此參數已替換為`branches_to_be_notified` | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected" | | `push_events` | boolean | false | 啟用推送事件通知 | | `issues_events` | boolean | false | 啟用問題事件通知 | | `confidential_issues_events` | boolean | false | Enable notifications for confidential issue events | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `note_events` | boolean | false | 啟用筆記事件通知 | | `confidential_note_events` | boolean | false | 啟用機密筆記事件的通知 | | `pipeline_events` | boolean | false | 啟用管道事件通知 | | `wiki_page_events` | boolean | false | 啟用 Wiki 頁面事件的通知 | ### Delete Hangouts Chat service[](#delete-hangouts-chat-service "Permalink") 刪除項目的環聊聊天服務. ``` DELETE /projects/:id/services/hangouts-chat ``` ### Get Hangouts Chat service settings[](#get-hangouts-chat-service-settings "Permalink") 獲取項目的環聊聊天服務設置. ``` GET /projects/:id/services/hangouts-chat ``` ## HipChat[](#hipchat "Permalink") 私人群聊和即時消息 ### Create/Edit HipChat service[](#createedit-hipchat-service "Permalink") 為項目設置 HipChat 服務. ``` PUT /projects/:id/services/hipchat ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | 房間代幣 | | `color` | string | false | 房間顏色 | | `notify` | boolean | false | 啟用通知 | | `room` | string | false | 房間名稱或 ID | | `api_version` | string | false | 默認保留空白（v2） | | `server` | string | false | 默認保留空白. 例如， `https://hipchat.example.com` . | | `push_events` | boolean | false | 啟用推送事件通知 | | `issues_events` | boolean | false | 啟用問題事件通知 | | `confidential_issues_events` | boolean | false | 啟用機密問題事件的通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `note_events` | boolean | false | Enable notifications for note events | | `confidental_note_events` | boolean | false | 啟用機密筆記事件的通知 | | `pipeline_events` | boolean | false | 啟用管道事件通知 | ### Delete HipChat service[](#delete-hipchat-service "Permalink") 刪除項目的 HipChat 服務. ``` DELETE /projects/:id/services/hipchat ``` ### Get HipChat service settings[](#get-hipchat-service-settings "Permalink") 獲取項目的 HipChat 服務設置. ``` GET /projects/:id/services/hipchat ``` ## Irker (IRC gateway)[](#irker-irc-gateway "Permalink") 通過 Irker 網關在更新后將 IRC 消息發送到收件人列表. ### Create/Edit Irker (IRC gateway) service[](#createedit-irker-irc-gateway-service "Permalink") 為項目設置 Irker（IRC 網關）服務. > Irker 沒有內置的身份驗證，如果托管在防火墻外部，則容易受到 IRC 垃圾郵件的攻擊. 請確保在安全的網絡中運行守護程序，以防止濫用. 有關更多詳細信息，請閱讀： [http](http://www.catb.org/~esr/irker/security.html) : [//www.catb.org/~esr/irker/security.html](http://www.catb.org/~esr/irker/security.html) . ``` PUT /projects/:id/services/irker ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `recipients` | string | true | 用空格分隔的收件人/渠道 | | `default_irc_uri` | string | false | `irc://irc.network.net:6697/` | | `server_host` | string | false | localhost | | `server_port` | integer | false | 6659 | | `colorize_messages` | boolean | false | 為郵件著色 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Irker (IRC gateway) service[](#delete-irker-irc-gateway-service "Permalink") 刪除項目的 Irker（IRC 網關）服務. ``` DELETE /projects/:id/services/irker ``` ### Get Irker (IRC gateway) service settings[](#get-irker-irc-gateway-service-settings "Permalink") Get Irker (IRC gateway) service settings for a project. ``` GET /projects/:id/services/irker ``` ## Jira[](#jira "Permalink") 吉拉問題追蹤器. ### Get Jira service settings[](#get-jira-service-settings "Permalink") 獲取項目的 Jira 服務設置. ``` GET /projects/:id/services/jira ``` ### Create/Edit Jira service[](#createedit-jira-service "Permalink") 為項目設置 Jira 服務. > 與 GitLab 8.14 開始， `api_url` ， `issues_url` ， `new_issue_url`和`project_url`被替換`url` . 如果您使用的是舊版本，請[遵循此文檔](https://gitlab.com/gitlab-org/gitlab/blob/8-13-stable-ee/doc/api/services.md#jira) . ``` PUT /projects/:id/services/jira ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `url` | string | yes | 鏈接到該 GitLab 項目的 Jira 項目的 URL. 例如， `https://jira.example.com` . | | `api_url` | string | no | Jira 實例 API 的基本 URL. 如果未設置，將使用 Web URL 值. 例如， `https://jira-api.example.com` . | | `username` | string | yes | 創建用于 GitLab / Jira 的用戶的用戶名. | | `password` | string | yes | 創建的用于 GitLab / Jira 的用戶密碼. | | `active` | boolean | no | 激活或停用服務. 默認為 false（停用）. | | `jira_issue_transition_id` | string | no | 將問題移到關閉狀態的過渡的 ID. 您可以在 Jira 工作流管理（ **管理>問題>工作流** ）下找到該編號，方法是在所需項目工作流的" **操作** **"**下選擇" **查看** **"** . 每個狀態的 ID 可以在" **轉換（id）"**列下每個轉換名稱的括號內找到. 默認情況下，此 ID 設置為`2` . | | `commit_events` | boolean | false | 啟用提交事件通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `comment_on_event_enabled` | boolean | false | 在每個 GitLab 事件（提交/合并請求）的 Jira 問題中啟用評論 | ### Delete Jira service[](#delete-jira-service "Permalink") 從項目中刪除所有以前的 Jira 設置. ``` DELETE /projects/:id/services/jira ``` ## Slack slash commands[](#slack-slash-commands "Permalink") 能夠從 Slack 聊天實例接收斜線命令. ### Get Slack slash command service settings[](#get-slack-slash-command-service-settings "Permalink") 獲取項目的 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>" } } ``` ### Create/Edit Slack slash command service[](#createedit-slack-slash-command-service "Permalink") 為項目設置 Slack 斜杠命令. ``` PUT /projects/:id/services/slack-slash-commands ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | yes | Slack 令牌 | ### Delete Slack slash command service[](#delete-slack-slash-command-service "Permalink") 刪除項目的 Slack 斜杠命令服務. ``` DELETE /projects/:id/services/slack-slash-commands ``` ## Mattermost slash commands[](#mattermost-slash-commands "Permalink") 能夠從 Mattermost 聊天實例接收斜線命令. ### Get Mattermost slash command service settings[](#get-mattermost-slash-command-service-settings "Permalink") 獲取項目的 Mattermost 斜杠命令服務設置. ``` GET /projects/:id/services/mattermost-slash-commands ``` ### Create/Edit Mattermost slash command service[](#createedit-mattermost-slash-command-service "Permalink") 為項目設置 Mattermost 斜杠命令. ``` PUT /projects/:id/services/mattermost-slash-commands ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | yes | 最重要的令牌 | | `username` | string | no | 用于發布消息的用戶名 | ### Delete Mattermost slash command service[](#delete-mattermost-slash-command-service "Permalink") 刪除項目的 Mattermost 斜杠命令服務. ``` DELETE /projects/:id/services/mattermost-slash-commands ``` ## Packagist[](#packagist "Permalink") 當提交或標簽被推送到 GitLab 時，在 Packagist（主要的 Composer 存儲庫）上更新您的項目. ### Create/Edit Packagist service[](#createedit-packagist-service "Permalink") 為項目設置 Packagist 服務. ``` PUT /projects/:id/services/packagist ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `username` | string | yes | Packagist 帳戶的用戶名 | | `token` | string | yes | Packagist 服務器的 API 令牌 | | `server` | boolean | no | Packagist 服務器的 URL. 默認保留空白： [https](https://packagist.org) ： [//packagist.org](https://packagist.org) | | `push_events` | boolean | false | 啟用推送事件通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | ### Delete Packagist service[](#delete-packagist-service "Permalink") 刪除項目的 Packagist 服務. ``` DELETE /projects/:id/services/packagist ``` ### Get Packagist service settings[](#get-packagist-service-settings "Permalink") 獲取項目的 Packagist 服務設置. ``` GET /projects/:id/services/packagist ``` ## Pipeline-Emails[](#pipeline-emails "Permalink") 獲取有關 GitLab CI / CD 管道的電子郵件. ### Create/Edit Pipeline-Emails service[](#createedit-pipeline-emails-service "Permalink") 設置項目的管道電子郵件服務. ``` PUT /projects/:id/services/pipelines-email ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `recipients` | string | yes | 以逗號分隔的收件人電子郵件地址列表 | | `add_pusher` | boolean | no | 將推送器添加到收件人列表 | | `notify_only_broken_pipelines` | boolean | no | 僅通知斷開的管道 | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected" | | `notify_only_default_branch` | boolean | no | 僅針對默認分支發送通知（ [在 GitLab 12.0 中引入](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/28271) ） | | `pipeline_events` | boolean | false | 啟用管道事件通知 | ### Delete Pipeline-Emails service[](#delete-pipeline-emails-service "Permalink") 刪除項目的管道電子郵件服務. ``` DELETE /projects/:id/services/pipelines-email ``` ### Get Pipeline-Emails service settings[](#get-pipeline-emails-service-settings "Permalink") 獲取項目的管道電子郵件服務設置. ``` GET /projects/:id/services/pipelines-email ``` ## PivotalTracker[](#pivotaltracker "Permalink") 項目管理軟件（源提交端點） ### Create/Edit PivotalTracker service[](#createedit-pivotaltracker-service "Permalink") 為項目設置 PivotalTracker 服務. ``` PUT /projects/:id/services/pivotaltracker ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `token` | string | true | PivotalTracker 令牌 | | `restrict_to_branch` | boolean | false | 以逗號分隔的分支列表，將自動對其進行檢查. 保留空白以包括所有分支. | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete PivotalTracker service[](#delete-pivotaltracker-service "Permalink") 刪除項目的 PivotalTracker 服務. ``` DELETE /projects/:id/services/pivotaltracker ``` ### Get PivotalTracker service settings[](#get-pivotaltracker-service-settings "Permalink") 獲取項目的 PivotalTracker 服務設置. ``` GET /projects/:id/services/pivotaltracker ``` ## Prometheus[](#prometheus "Permalink") Prometheus 是一項功能強大的時間序列監視服務. ### Create/Edit Prometheus service[](#createedit-prometheus-service "Permalink") 為項目設置 Prometheus 服務. ``` PUT /projects/:id/services/prometheus ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `api_url` | string | true | Prometheus API 基本 URL. 例如， `http://prometheus.example.com/` . | | `google_iap_audience_client_id` | string | false | IAP 受保護資源的客戶端 ID（看起來像 IAP_CLIENT_ID.apps.googleusercontent.com） | | `google_iap_service_account_json` | string | false | 您的服務帳戶的`credentials.json`文件，例如{" type"：" service_account"，" project_id"：…} | ### Delete Prometheus service[](#delete-prometheus-service "Permalink") 刪除項目的 Prometheus 服務. ``` DELETE /projects/:id/services/prometheus ``` ### Get Prometheus service settings[](#get-prometheus-service-settings "Permalink") 獲取項目的 Prometheus 服務設置. ``` GET /projects/:id/services/prometheus ``` ## Pushover[](#pushover "Permalink") 通過 Pushover，可以輕松在 Android 設備，iPhone，iPad 和臺式機上獲取實時通知. ### Create/Edit Pushover service[](#createedit-pushover-service "Permalink") 為項目設置 Pushover 服務. ``` PUT /projects/:id/services/pushover ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `api_key` | string | true | Your application key | | `user_key` | string | true | 您的用戶密鑰 | | `priority` | string | true | 優先事項 | | `device` | string | false | 對于所有活動設備保留空白 | | `sound` | string | false | 通知的聲音 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Pushover service[](#delete-pushover-service "Permalink") 刪除項目的 Pushover 服務. ``` DELETE /projects/:id/services/pushover ``` ### Get Pushover service settings[](#get-pushover-service-settings "Permalink") 獲取項目的 Pushover 服務設置. ``` GET /projects/:id/services/pushover ``` ## Redmine[](#redmine "Permalink") Redmine 問題追蹤器 ### Create/Edit Redmine service[](#createedit-redmine-service "Permalink") 為項目設置 Redmine 服務. ``` PUT /projects/:id/services/redmine ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `new_issue_url` | string | true | 新發行網址 | | `project_url` | string | true | 項目網址 | | `issues_url` | string | true | 發行網址 | | `description` | string | false | Description | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete Redmine service[](#delete-redmine-service "Permalink") 刪除項目的 Redmine 服務. ``` DELETE /projects/:id/services/redmine ``` ### Get Redmine service settings[](#get-redmine-service-settings "Permalink") 獲取項目的 Redmine 服務設置. ``` GET /projects/:id/services/redmine ``` ## Slack notifications[](#slack-notifications "Permalink") 在 Slack 中接收事件通知 ### Create/Edit Slack service[](#createedit-slack-service "Permalink") 為項目設置 Slack 服務. ``` PUT /projects/:id/services/slack ``` > **注意：** [v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)中[引入了](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)特定的事件參數（例如`push_events`標志和`push_channel` ） Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `webhook` | string | true | `https://hooks.slack.com/services/...` | | `username` | string | false | username | | `channel` | string | false | 如果未配置其他頻道，則使用默認頻道 | | `notify_only_broken_pipelines` | boolean | false | 發送有關管道中斷的通知 | | `notify_only_default_branch` | boolean | false | 已棄用：此參數已替換為`branches_to_be_notified` | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected" | | `commit_events` | boolean | false | 啟用提交事件通知 | | `confidential_issue_channel` | string | false | 接收機密問題事件通知的渠道的名稱 | | `confidential_issues_events` | boolean | false | 啟用機密問題事件的通知 | | `confidential_note_channel` | string | false | 接收機密筆記事件通知的渠道的名稱 | | `confidential_note_events` | boolean | false | 啟用機密筆記事件的通知 | | `deployment_channel` | string | false | 接收部署事件通知的通道的名稱 | | `deployment_events` | boolean | false | 啟用部署事件通知 | | `issue_channel` | string | false | 接收問題事件通知的渠道的名稱 | | `issues_events` | boolean | false | 啟用問題事件通知 | | `job_events` | boolean | false | 啟用工作事件通知 | | `merge_request_channel` | string | false | 接收合并請求事件通知的通道的名稱 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `note_channel` | string | false | 接收音符事件通知的頻道名稱 | | `note_events` | boolean | false | 啟用筆記事件通知 | | `pipeline_channel` | string | false | 接收管道事件通知的通道的名稱 | | `pipeline_events` | boolean | false | 啟用管道事件通知 | | `push_channel` | string | false | 接收推送事件通知的通道的名稱 | | `push_events` | boolean | false | 啟用推送事件通知 | | `tag_push_channel` | string | false | 接收標簽推送事件通知的通道的名稱 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `wiki_page_channel` | string | false | 接收維基頁面事件通知的頻道名稱 | | `wiki_page_events` | boolean | false | 啟用 Wiki 頁面事件的通知 | ### Delete Slack service[](#delete-slack-service "Permalink") 刪除項目的 Slack 服務. ``` DELETE /projects/:id/services/slack ``` ### Get Slack service settings[](#get-slack-service-settings "Permalink") 獲取項目的 Slack 服務設置. ``` GET /projects/:id/services/slack ``` ## Microsoft Teams[](#microsoft-teams "Permalink") 群聊軟件 ### Create/Edit Microsoft Teams service[](#createedit-microsoft-teams-service "Permalink") 為項目設置 Microsoft Teams 服務. ``` PUT /projects/:id/services/microsoft-teams ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `webhook` | string | true | Microsoft Teams 網絡掛鉤. 例如， `https://outlook.office.com/webhook/...` | | `notify_only_broken_pipelines` | boolean | false | 發送有關管道中斷的通知 | | `notify_only_default_branch` | boolean | false | 已棄用：此參數已替換為`branches_to_be_notified` | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected" | | `push_events` | boolean | false | Enable notifications for push events | | `issues_events` | boolean | false | 啟用問題事件通知 | | `confidential_issues_events` | boolean | false | 啟用機密問題事件的通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `note_events` | boolean | false | 啟用筆記事件通知 | | `confidential_note_events` | boolean | false | 啟用機密筆記事件的通知 | | `pipeline_events` | boolean | false | 啟用管道事件通知 | | `wiki_page_events` | boolean | false | 啟用 Wiki 頁面事件的通知 | ### Delete Microsoft Teams service[](#delete-microsoft-teams-service "Permalink") 刪除項目的 Microsoft Teams 服務. ``` DELETE /projects/:id/services/microsoft-teams ``` ### Get Microsoft Teams service settings[](#get-microsoft-teams-service-settings "Permalink") 獲取項目的 Microsoft Teams 服務設置. ``` GET /projects/:id/services/microsoft-teams ``` ## Mattermost notifications[](#mattermost-notifications "Permalink") 在 Mattermost 接收事件通知 ### Create/Edit Mattermost notifications service[](#createedit-mattermost-notifications-service "Permalink") 為項目設置 Mattermost 服務. ``` PUT /projects/:id/services/mattermost ``` > **注意：** [v10.4](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)中[引入了](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435)特定的事件參數（例如`push_events`標志和`push_channel` ） Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `webhook` | string | true | 最重要的網絡掛鉤. 例如， `http://mattermost_host/hooks/...` | | `username` | string | false | username | | `channel` | string | false | 如果未配置其他頻道，則使用默認頻道 | | `notify_only_broken_pipelines` | boolean | false | 發送有關管道中斷的通知 | | `notify_only_default_branch` | boolean | false | 已棄用：此參數已替換為`branches_to_be_notified` | | `branches_to_be_notified` | string | all | 發送通知的分支. 有效選項為"所有"，"默認"，"受保護"和" default_and_protected" | | `push_events` | boolean | false | 啟用推送事件通知 | | `issues_events` | boolean | false | 啟用問題事件通知 | | `confidential_issues_events` | boolean | false | 啟用機密問題事件的通知 | | `merge_requests_events` | boolean | false | 啟用合并請求事件的通知 | | `tag_push_events` | boolean | false | 啟用標簽推送事件的通知 | | `note_events` | boolean | false | 啟用筆記事件通知 | | `confidential_note_events` | boolean | false | 啟用機密筆記事件的通知 | | `pipeline_events` | boolean | false | 啟用管道事件通知 | | `wiki_page_events` | boolean | false | 啟用 Wiki 頁面事件的通知 | | `push_channel` | string | false | 接收推送事件通知的通道的名稱 | | `issue_channel` | string | false | 接收問題事件通知的渠道的名稱 | | `confidential_issue_channel` | string | false | 接收機密問題事件通知的渠道的名稱 | | `merge_request_channel` | string | false | 接收合并請求事件通知的通道的名稱 | | `note_channel` | string | false | 接收音符事件通知的頻道名稱 | | `confidential_note_channel` | boolean | 接收機密筆記事件通知的渠道的名稱 | ? | | `tag_push_channel` | string | false | 接收標簽推送事件通知的通道的名稱 | | `pipeline_channel` | string | false | 接收管道事件通知的通道的名稱 | | `wiki_page_channel` | string | false | 接收維基頁面事件通知的頻道名稱 | ### Delete Mattermost notifications service[](#delete-mattermost-notifications-service "Permalink") 刪除項目的 Mattermost Notifications 服務. ``` DELETE /projects/:id/services/mattermost ``` ### Get Mattermost notifications service settings[](#get-mattermost-notifications-service-settings "Permalink") 獲取項目的"最重要的通知"服務設置. ``` GET /projects/:id/services/mattermost ``` ## JetBrains TeamCity CI[](#jetbrains-teamcity-ci "Permalink") 持續集成和構建服務器 ### Create/Edit JetBrains TeamCity CI service[](#createedit-jetbrains-teamcity-ci-service "Permalink") 為項目設置 JetBrains TeamCity CI 服務. > TeamCity 中的構建配置必須使用構建格式編號`%build.vcs.number%`您還將要配置對所有分支的監視，以便合并請求得以構建，該設置位于 VSC 根高級設置中. ``` PUT /projects/:id/services/teamcity ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `teamcity_url` | string | true | TeamCity 根 URL. 例如， `https://teamcity.example.com` | | `build_type` | string | true | 構建配置 ID | | `username` | string | true | 有權觸發手動構建的用戶 | | `password` | string | true | 用戶密碼 | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete JetBrains TeamCity CI service[](#delete-jetbrains-teamcity-ci-service "Permalink") 刪除項目的 JetBrains TeamCity CI 服務. ``` DELETE /projects/:id/services/teamcity ``` ### Get JetBrains TeamCity CI service settings[](#get-jetbrains-teamcity-ci-service-settings "Permalink") 獲取項目的 JetBrains TeamCity CI 服務設置. ``` GET /projects/:id/services/teamcity ``` ## Jenkins CI[](#jenkins-ci-starter "Permalink") 持續集成和構建服務器 ### Create/Edit Jenkins CI service[](#createedit-jenkins-ci-service "Permalink") 為項目設置 Jenkins CI 服務. ``` PUT /projects/:id/services/jenkins ``` Parameters: * `jenkins_url` （ **必填** ） `jenkins_url` URL，例如`http://jenkins.example.com` * `project_name` （ **必需** ）-URL 友好的項目名稱. 示例：my_project_name * `username` （可選）-有權訪問 Jenkins 服務器的`username` （如果適用） * `password` （可選）-用戶的密碼 ### Delete Jenkins CI service[](#delete-jenkins-ci-service "Permalink") 刪除項目的 Jenkins CI 服務. ``` DELETE /projects/:id/services/jenkins ``` ### Get Jenkins CI service settings[](#get-jenkins-ci-service-settings "Permalink") 獲取項目的 Jenkins CI 服務設置. ``` GET /projects/:id/services/jenkins ``` ## Jenkins CI (Deprecated) Service[](#jenkins-ci-deprecated-service "Permalink") 持續集成和構建服務器 **注意：**此服務已[在 v13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/1600)中[刪除](https://gitlab.com/gitlab-org/gitlab/-/issues/1600) ### Create/Edit Jenkins CI (Deprecated) service[](#createedit-jenkins-ci-deprecated-service "Permalink") 為項目設置 Jenkins CI（不推薦使用）服務. ``` PUT /projects/:id/services/jenkins-deprecated ``` Parameters: * `project_url` （ **必填** ）-Jenkins 項目網址，例如`http://jenkins.example.com/job/my-project/` * `multiproject_enabled` （可選）-在 Jenkins GitLab Hook 插件中配置了多項目模式 * `pass_unstable` （可選）-不穩定的版本將被視為通過 ### Delete Jenkins CI (Deprecated) service[](#delete-jenkins-ci-deprecated-service "Permalink") 刪除項目的 Jenkins CI（不推薦使用）服務. ``` DELETE /projects/:id/services/jenkins-deprecated ``` ### Get Jenkins CI (Deprecated) service settings[](#get-jenkins-ci-deprecated-service-settings "Permalink") 獲取項目的 Jenkins CI（不推薦使用）服務設置. ``` GET /projects/:id/services/jenkins-deprecated ``` ## MockCI[](#mockci "Permalink") 模擬一個外部配置項. 有關伴隨模擬服務的示例，請參見[`gitlab-org/gitlab-mock-ci-service`](https://gitlab.com/gitlab-org/gitlab-mock-ci-service) service. 僅當您的環境設置為開發時，此服務才可用. ### Create/Edit MockCI service[](#createedit-mockci-service "Permalink") 為項目設置 MockCI 服務. ``` PUT /projects/:id/services/mock-ci ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `mock_service_url` | string | true | `http://localhost:4004` | ### Delete MockCI service[](#delete-mockci-service "Permalink") 刪除項目的 MockCI 服務. ``` DELETE /projects/:id/services/mock-ci ``` ### Get MockCI service settings[](#get-mockci-service-settings "Permalink") 獲取項目的 MockCI 服務設置. ``` GET /projects/:id/services/mock-ci ``` ## YouTrack[](#youtrack "Permalink") YouTrack 問題追蹤器 ### Create/Edit YouTrack service[](#createedit-youtrack-service "Permalink") 為項目設置 YouTrack 服務. ``` PUT /projects/:id/services/youtrack ``` Parameters: | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `issues_url` | string | true | 發行網址 | | `project_url` | string | true | 項目網址 | | `description` | string | false | Description | | `push_events` | boolean | false | 啟用推送事件通知 | ### Delete YouTrack Service[](#delete-youtrack-service "Permalink") 刪除項目的 YouTrack 服務. ``` DELETE /projects/:id/services/youtrack ``` ### Get YouTrack Service Settings[](#get-youtrack-service-settings "Permalink") 獲取項目的 YouTrack 服務設置. ``` GET /projects/:id/services/youtrack ```