summaryrefslogtreecommitdiff
path: root/doc/api/services.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-03-19 09:35:24 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-03-19 09:35:24 +0000
commit1d20d43661f3e98bde2bb5dc163a45fd90f8ac88 (patch)
tree53feb6983348a364ed4f52a4108866bf4ff0a599 /doc/api/services.md
parent2774ddc308f96f49a0f26871ff544681229f4eee (diff)
downloadgitlab-ce-1d20d43661f3e98bde2bb5dc163a45fd90f8ac88.tar.gz
Add latest changes from gitlab-org/gitlab@12-9-stable-ee
Diffstat (limited to 'doc/api/services.md')
-rw-r--r--doc/api/services.md212
1 files changed, 106 insertions, 106 deletions
diff --git a/doc/api/services.md b/doc/api/services.md
index 2f70cb21964..8c70033d71d 100644
--- a/doc/api/services.md
+++ b/doc/api/services.md
@@ -8,7 +8,7 @@
Get a list of all active project services.
-```
+```plaintext
GET /projects/:id/services
```
@@ -69,7 +69,7 @@ Set Asana service for a project.
> This service adds commit messages as comments to Asana tasks. Once enabled, commit messages are checked for Asana task URLs (for example, `https://app.asana.com/0/123456/987654`) or task IDs starting with # (for example, `#987654`). Every task ID found will get the commit comment added to it. You can also close a task with a message containing: `fix #123456`. You can find your API Keys here: <https://asana.com/developers/documentation/getting-started/auth#api-key>.
-```
+```plaintext
PUT /projects/:id/services/asana
```
@@ -85,7 +85,7 @@ Parameters:
Delete Asana service for a project.
-```
+```plaintext
DELETE /projects/:id/services/asana
```
@@ -93,7 +93,7 @@ DELETE /projects/:id/services/asana
Get Asana service settings for a project.
-```
+```plaintext
GET /projects/:id/services/asana
```
@@ -105,7 +105,7 @@ Project Management Software (Source Commits Endpoint)
Set Assembla service for a project.
-```
+```plaintext
PUT /projects/:id/services/assembla
```
@@ -121,7 +121,7 @@ Parameters:
Delete Assembla service for a project.
-```
+```plaintext
DELETE /projects/:id/services/assembla
```
@@ -129,7 +129,7 @@ DELETE /projects/:id/services/assembla
Get Assembla service settings for a project.
-```
+```plaintext
GET /projects/:id/services/assembla
```
@@ -143,7 +143,7 @@ Set Atlassian Bamboo CI service for a project.
> You must set up automatic revision labeling and a repository trigger in Bamboo.
-```
+```plaintext
PUT /projects/:id/services/bamboo
```
@@ -161,7 +161,7 @@ Parameters:
Delete Atlassian Bamboo CI service for a project.
-```
+```plaintext
DELETE /projects/:id/services/bamboo
```
@@ -169,7 +169,7 @@ DELETE /projects/:id/services/bamboo
Get Atlassian Bamboo CI service settings for a project.
-```
+```plaintext
GET /projects/:id/services/bamboo
```
@@ -181,7 +181,7 @@ Bugzilla Issue Tracker
Set Bugzilla service for a project.
-```
+```plaintext
PUT /projects/:id/services/bugzilla
```
@@ -200,7 +200,7 @@ Parameters:
Delete Bugzilla service for a project.
-```
+```plaintext
DELETE /projects/:id/services/bugzilla
```
@@ -208,7 +208,7 @@ DELETE /projects/:id/services/bugzilla
Get Bugzilla service settings for a project.
-```
+```plaintext
GET /projects/:id/services/bugzilla
```
@@ -220,7 +220,7 @@ Continuous integration and deployments
Set Buildkite service for a project.
-```
+```plaintext
PUT /projects/:id/services/buildkite
```
@@ -237,7 +237,7 @@ Parameters:
Delete Buildkite service for a project.
-```
+```plaintext
DELETE /projects/:id/services/buildkite
```
@@ -245,7 +245,7 @@ DELETE /projects/:id/services/buildkite
Get Buildkite service settings for a project.
-```
+```plaintext
GET /projects/:id/services/buildkite
```
@@ -257,7 +257,7 @@ Simple web-based real-time group chat
Set Campfire service for a project.
-```
+```plaintext
PUT /projects/:id/services/campfire
```
@@ -274,7 +274,7 @@ Parameters:
Delete Campfire service for a project.
-```
+```plaintext
DELETE /projects/:id/services/campfire
```
@@ -282,7 +282,7 @@ DELETE /projects/:id/services/campfire
Get Campfire service settings for a project.
-```
+```plaintext
GET /projects/:id/services/campfire
```
@@ -294,7 +294,7 @@ Unify Circuit RTC and collaboration tool.
Set Unify Circuit service for a project.
-```
+```plaintext
PUT /projects/:id/services/unify-circuit
```
@@ -319,7 +319,7 @@ Parameters:
Delete Unify Circuit service for a project.
-```
+```plaintext
DELETE /projects/:id/services/unify-circuit
```
@@ -327,7 +327,7 @@ DELETE /projects/:id/services/unify-circuit
Get Unify Circuit service settings for a project.
-```
+```plaintext
GET /projects/:id/services/unify-circuit
```
@@ -339,7 +339,7 @@ Custom issue tracker
Set Custom Issue Tracker service for a project.
-```
+```plaintext
PUT /projects/:id/services/custom-issue-tracker
```
@@ -358,7 +358,7 @@ Parameters:
Delete Custom Issue Tracker service for a project.
-```
+```plaintext
DELETE /projects/:id/services/custom-issue-tracker
```
@@ -366,7 +366,7 @@ DELETE /projects/:id/services/custom-issue-tracker
Get Custom Issue Tracker service settings for a project.
-```
+```plaintext
GET /projects/:id/services/custom-issue-tracker
```
@@ -378,7 +378,7 @@ Drone is a Continuous Integration platform built on Docker, written in Go
Set Drone CI service for a project.
-```
+```plaintext
PUT /projects/:id/services/drone-ci
```
@@ -397,7 +397,7 @@ Parameters:
Delete Drone CI service for a project.
-```
+```plaintext
DELETE /projects/:id/services/drone-ci
```
@@ -405,7 +405,7 @@ DELETE /projects/:id/services/drone-ci
Get Drone CI service settings for a project.
-```
+```plaintext
GET /projects/:id/services/drone-ci
```
@@ -417,7 +417,7 @@ Email the commits and diff of each push to a list of recipients.
Set Emails on push service for a project.
-```
+```plaintext
PUT /projects/:id/services/emails-on-push
```
@@ -436,7 +436,7 @@ Parameters:
Delete Emails on push service for a project.
-```
+```plaintext
DELETE /projects/:id/services/emails-on-push
```
@@ -444,7 +444,7 @@ DELETE /projects/:id/services/emails-on-push
Get Emails on push service settings for a project.
-```
+```plaintext
GET /projects/:id/services/emails-on-push
```
@@ -456,7 +456,7 @@ Replaces the link to the internal wiki with a link to an external wiki.
Set External Wiki service for a project.
-```
+```plaintext
PUT /projects/:id/services/external-wiki
```
@@ -470,7 +470,7 @@ Parameters:
Delete External Wiki service for a project.
-```
+```plaintext
DELETE /projects/:id/services/external-wiki
```
@@ -478,7 +478,7 @@ DELETE /projects/:id/services/external-wiki
Get External Wiki service settings for a project.
-```
+```plaintext
GET /projects/:id/services/external-wiki
```
@@ -490,7 +490,7 @@ Flowdock is a collaboration web app for technical teams.
Set Flowdock service for a project.
-```
+```plaintext
PUT /projects/:id/services/flowdock
```
@@ -505,7 +505,7 @@ Parameters:
Delete Flowdock service for a project.
-```
+```plaintext
DELETE /projects/:id/services/flowdock
```
@@ -513,7 +513,7 @@ DELETE /projects/:id/services/flowdock
Get Flowdock service settings for a project.
-```
+```plaintext
GET /projects/:id/services/flowdock
```
@@ -525,7 +525,7 @@ Code collaboration software.
Set GitHub service for a project.
-```
+```plaintext
PUT /projects/:id/services/github
```
@@ -541,7 +541,7 @@ Parameters:
Delete GitHub service for a project.
-```
+```plaintext
DELETE /projects/:id/services/github
```
@@ -549,7 +549,7 @@ DELETE /projects/:id/services/github
Get GitHub service settings for a project.
-```
+```plaintext
GET /projects/:id/services/github
```
@@ -563,11 +563,11 @@ Google GSuite team collaboration tool.
Set Hangouts Chat service for a project.
-```
+```plaintext
PUT /projects/:id/services/hangouts-chat
```
->**Note:** Specific event parameters (e.g. `push_events` flag) were [introduced in v10.4][11435]
+>**Note:** Specific event parameters (for example, `push_events` flag) were [introduced in v10.4][11435]
Parameters:
@@ -591,7 +591,7 @@ Parameters:
Delete Hangouts Chat service for a project.
-```
+```plaintext
DELETE /projects/:id/services/hangouts-chat
```
@@ -599,7 +599,7 @@ DELETE /projects/:id/services/hangouts-chat
Get Hangouts Chat service settings for a project.
-```
+```plaintext
GET /projects/:id/services/hangouts-chat
```
@@ -611,7 +611,7 @@ Private group chat and IM
Set HipChat service for a project.
-```
+```plaintext
PUT /projects/:id/services/hipchat
```
@@ -638,7 +638,7 @@ Parameters:
Delete HipChat service for a project.
-```
+```plaintext
DELETE /projects/:id/services/hipchat
```
@@ -646,7 +646,7 @@ DELETE /projects/:id/services/hipchat
Get HipChat service settings for a project.
-```
+```plaintext
GET /projects/:id/services/hipchat
```
@@ -658,9 +658,9 @@ Send IRC messages, on update, to a list of recipients through an Irker gateway.
Set Irker (IRC gateway) service for a project.
-> NOTE: Irker does NOT have built-in authentication, which makes it vulnerable to spamming IRC channels if it is hosted outside of a firewall. Please make sure you run the daemon within a secured network to prevent abuse. For more details, read: <http://www.catb.org/~esr/irker/security.html>.
+> NOTE: Irker does NOT have built-in authentication, which makes it vulnerable to spamming IRC channels if it is hosted outside of a firewall. Please make sure you run the daemon within a secured network to prevent abuse. For more details, read: <http://www.catb.org/~esr/irker/security.html>.
-```
+```plaintext
PUT /projects/:id/services/irker
```
@@ -679,7 +679,7 @@ Parameters:
Delete Irker (IRC gateway) service for a project.
-```
+```plaintext
DELETE /projects/:id/services/irker
```
@@ -687,7 +687,7 @@ DELETE /projects/:id/services/irker
Get Irker (IRC gateway) service settings for a project.
-```
+```plaintext
GET /projects/:id/services/irker
```
@@ -699,7 +699,7 @@ Jira issue tracker.
Get Jira service settings for a project.
-```
+```plaintext
GET /projects/:id/services/jira
```
@@ -711,7 +711,7 @@ Set Jira service for a project.
> `project_url` are replaced by `url`. If you are using an
> older version, [follow this documentation](https://gitlab.com/gitlab-org/gitlab/blob/8-13-stable-ee/doc/api/services.md#jira).
-```
+```plaintext
PUT /projects/:id/services/jira
```
@@ -733,7 +733,7 @@ Parameters:
Remove all previously Jira settings from a project.
-```
+```plaintext
DELETE /projects/:id/services/jira
```
@@ -745,7 +745,7 @@ Ability to receive slash commands from a Slack chat instance.
Get Slack slash command service settings for a project.
-```
+```plaintext
GET /projects/:id/services/slack-slash-commands
```
@@ -778,7 +778,7 @@ Example response:
Set Slack slash command for a project.
-```
+```plaintext
PUT /projects/:id/services/slack-slash-commands
```
@@ -792,7 +792,7 @@ Parameters:
Delete Slack slash command service for a project.
-```
+```plaintext
DELETE /projects/:id/services/slack-slash-commands
```
@@ -804,7 +804,7 @@ Ability to receive slash commands from a Mattermost chat instance.
Get Mattermost slash command service settings for a project.
-```
+```plaintext
GET /projects/:id/services/mattermost-slash-commands
```
@@ -812,7 +812,7 @@ GET /projects/:id/services/mattermost-slash-commands
Set Mattermost slash command for a project.
-```
+```plaintext
PUT /projects/:id/services/mattermost-slash-commands
```
@@ -827,19 +827,19 @@ Parameters:
Delete Mattermost slash command service for a project.
-```
+```plaintext
DELETE /projects/:id/services/mattermost-slash-commands
```
## Packagist
-Update your project on Packagist, the main Composer repository, when commits or tags are pushed to GitLab.
+Update your project on Packagist (the main Composer repository) when commits or tags are pushed to GitLab.
### Create/Edit Packagist service
Set Packagist service for a project.
-```
+```plaintext
PUT /projects/:id/services/packagist
```
@@ -858,7 +858,7 @@ Parameters:
Delete Packagist service for a project.
-```
+```plaintext
DELETE /projects/:id/services/packagist
```
@@ -866,7 +866,7 @@ DELETE /projects/:id/services/packagist
Get Packagist service settings for a project.
-```
+```plaintext
GET /projects/:id/services/packagist
```
@@ -878,7 +878,7 @@ Get emails for GitLab CI pipelines.
Set Pipeline-Emails service for a project.
-```
+```plaintext
PUT /projects/:id/services/pipelines-email
```
@@ -897,7 +897,7 @@ Parameters:
Delete Pipeline-Emails service for a project.
-```
+```plaintext
DELETE /projects/:id/services/pipelines-email
```
@@ -905,7 +905,7 @@ DELETE /projects/:id/services/pipelines-email
Get Pipeline-Emails service settings for a project.
-```
+```plaintext
GET /projects/:id/services/pipelines-email
```
@@ -917,7 +917,7 @@ Project Management Software (Source Commits Endpoint)
Set PivotalTracker service for a project.
-```
+```plaintext
PUT /projects/:id/services/pivotaltracker
```
@@ -933,7 +933,7 @@ Parameters:
Delete PivotalTracker service for a project.
-```
+```plaintext
DELETE /projects/:id/services/pivotaltracker
```
@@ -941,7 +941,7 @@ DELETE /projects/:id/services/pivotaltracker
Get PivotalTracker service settings for a project.
-```
+```plaintext
GET /projects/:id/services/pivotaltracker
```
@@ -953,7 +953,7 @@ Prometheus is a powerful time-series monitoring service.
Set Prometheus service for a project.
-```
+```plaintext
PUT /projects/:id/services/prometheus
```
@@ -967,7 +967,7 @@ Parameters:
Delete Prometheus service for a project.
-```
+```plaintext
DELETE /projects/:id/services/prometheus
```
@@ -975,7 +975,7 @@ DELETE /projects/:id/services/prometheus
Get Prometheus service settings for a project.
-```
+```plaintext
GET /projects/:id/services/prometheus
```
@@ -987,7 +987,7 @@ Pushover makes it easy to get real-time notifications on your Android device, iP
Set Pushover service for a project.
-```
+```plaintext
PUT /projects/:id/services/pushover
```
@@ -1006,7 +1006,7 @@ Parameters:
Delete Pushover service for a project.
-```
+```plaintext
DELETE /projects/:id/services/pushover
```
@@ -1014,7 +1014,7 @@ DELETE /projects/:id/services/pushover
Get Pushover service settings for a project.
-```
+```plaintext
GET /projects/:id/services/pushover
```
@@ -1026,7 +1026,7 @@ Redmine issue tracker
Set Redmine service for a project.
-```
+```plaintext
PUT /projects/:id/services/redmine
```
@@ -1044,7 +1044,7 @@ Parameters:
Delete Redmine service for a project.
-```
+```plaintext
DELETE /projects/:id/services/redmine
```
@@ -1052,7 +1052,7 @@ DELETE /projects/:id/services/redmine
Get Redmine service settings for a project.
-```
+```plaintext
GET /projects/:id/services/redmine
```
@@ -1064,11 +1064,11 @@ Receive event notifications in Slack
Set Slack service for a project.
-```
+```plaintext
PUT /projects/:id/services/slack
```
->**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435]
+>**Note:** Specific event parameters (for example, `push_events` flag and `push_channel`) were [introduced in v10.4][11435]
Parameters:
@@ -1107,7 +1107,7 @@ Parameters:
Delete Slack service for a project.
-```
+```plaintext
DELETE /projects/:id/services/slack
```
@@ -1115,7 +1115,7 @@ DELETE /projects/:id/services/slack
Get Slack service settings for a project.
-```
+```plaintext
GET /projects/:id/services/slack
```
@@ -1127,7 +1127,7 @@ Group Chat Software
Set Microsoft Teams service for a project.
-```
+```plaintext
PUT /projects/:id/services/microsoft-teams
```
@@ -1145,7 +1145,7 @@ Parameters:
| `merge_requests_events` | boolean | false | Enable notifications for merge request events |
| `tag_push_events` | boolean | false | Enable notifications for tag push events |
| `note_events` | boolean | false | Enable notifications for note events |
-| `confidental_note_events` | boolean | false | Enable notifications for confidential note events |
+| `confidential_note_events` | boolean | false | Enable notifications for confidential note events |
| `pipeline_events` | boolean | false | Enable notifications for pipeline events |
| `wiki_page_events` | boolean | false | Enable notifications for wiki page events |
@@ -1153,7 +1153,7 @@ Parameters:
Delete Microsoft Teams service for a project.
-```
+```plaintext
DELETE /projects/:id/services/microsoft-teams
```
@@ -1161,7 +1161,7 @@ DELETE /projects/:id/services/microsoft-teams
Get Microsoft Teams service settings for a project.
-```
+```plaintext
GET /projects/:id/services/microsoft-teams
```
@@ -1173,11 +1173,11 @@ Receive event notifications in Mattermost
Set Mattermost service for a project.
-```
+```plaintext
PUT /projects/:id/services/mattermost
```
->**Note:** Specific event parameters (e.g. `push_events` flag and `push_channel`) were [introduced in v10.4][11435]
+>**Note:** Specific event parameters (for example, `push_events` flag and `push_channel`) were [introduced in v10.4][11435]
Parameters:
@@ -1212,7 +1212,7 @@ Parameters:
Delete Mattermost Notifications service for a project.
-```
+```plaintext
DELETE /projects/:id/services/mattermost
```
@@ -1220,7 +1220,7 @@ DELETE /projects/:id/services/mattermost
Get Mattermost notifications service settings for a project.
-```
+```plaintext
GET /projects/:id/services/mattermost
```
@@ -1234,7 +1234,7 @@ Set JetBrains TeamCity CI service for a project.
> The build configuration in Teamcity must use the build format number %build.vcs.number% you will also want to configure monitoring of all branches so merge requests build, that setting is in the vsc root advanced settings.
-```
+```plaintext
PUT /projects/:id/services/teamcity
```
@@ -1252,7 +1252,7 @@ Parameters:
Delete JetBrains TeamCity CI service for a project.
-```
+```plaintext
DELETE /projects/:id/services/teamcity
```
@@ -1260,7 +1260,7 @@ DELETE /projects/:id/services/teamcity
Get JetBrains TeamCity CI service settings for a project.
-```
+```plaintext
GET /projects/:id/services/teamcity
```
@@ -1272,7 +1272,7 @@ A continuous integration and build server
Set Jenkins CI service for a project.
-```
+```plaintext
PUT /projects/:id/services/jenkins
```
@@ -1287,7 +1287,7 @@ Parameters:
Delete Jenkins CI service for a project.
-```
+```plaintext
DELETE /projects/:id/services/jenkins
```
@@ -1295,7 +1295,7 @@ DELETE /projects/:id/services/jenkins
Get Jenkins CI service settings for a project.
-```
+```plaintext
GET /projects/:id/services/jenkins
```
@@ -1307,7 +1307,7 @@ A continuous integration and build server
Set Jenkins CI (Deprecated) service for a project.
-```
+```plaintext
PUT /projects/:id/services/jenkins-deprecated
```
@@ -1321,7 +1321,7 @@ Parameters:
Delete Jenkins CI (Deprecated) service for a project.
-```
+```plaintext
DELETE /projects/:id/services/jenkins-deprecated
```
@@ -1329,7 +1329,7 @@ DELETE /projects/:id/services/jenkins-deprecated
Get Jenkins CI (Deprecated) service settings for a project.
-```
+```plaintext
GET /projects/:id/services/jenkins-deprecated
```
@@ -1343,7 +1343,7 @@ This service is only available when your environment is set to development.
Set MockCI service for a project.
-```
+```plaintext
PUT /projects/:id/services/mock-ci
```
@@ -1357,7 +1357,7 @@ Parameters:
Delete MockCI service for a project.
-```
+```plaintext
DELETE /projects/:id/services/mock-ci
```
@@ -1365,7 +1365,7 @@ DELETE /projects/:id/services/mock-ci
Get MockCI service settings for a project.
-```
+```plaintext
GET /projects/:id/services/mock-ci
```
@@ -1379,7 +1379,7 @@ YouTrack issue tracker
Set YouTrack service for a project.
-```
+```plaintext
PUT /projects/:id/services/youtrack
```
@@ -1396,7 +1396,7 @@ Parameters:
Delete YouTrack service for a project.
-```
+```plaintext
DELETE /projects/:id/services/youtrack
```
@@ -1404,6 +1404,6 @@ DELETE /projects/:id/services/youtrack
Get YouTrack service settings for a project.
-```
+```plaintext
GET /projects/:id/services/youtrack
```