swagger: '2.0'
info:
title: GitLab access_requests integrations API
version: v4
description: Operations related to access requests
host: gitlab.com
produces:
- application/json
tags:
- name: integrations
description: Operations related to integrations
paths:
/api/v4/groups/{id}/integrations:
get:
summary: List all active integrations
description: Get a list of all active integrations.
produces:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
responses:
'200':
description: List all active integrations
schema:
type: array
items:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: getApiV4GroupsIdIntegrations
/api/v4/groups/{id}/integrations/apple-app-store:
put:
summary: Create/Edit Apple App Store integration
description: Set Apple App Store integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsAppleAppStore
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsAppleAppStore'
responses:
'200':
description: Create/Edit Apple App Store integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsAppleAppStore
/api/v4/groups/{id}/integrations/asana:
put:
summary: Create/Edit Asana integration
description: Set Asana integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsAsana
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsAsana'
responses:
'200':
description: Create/Edit Asana integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsAsana
/api/v4/groups/{id}/integrations/assembla:
put:
summary: Create/Edit Assembla integration
description: Set Assembla integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsAssembla
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsAssembla'
responses:
'200':
description: Create/Edit Assembla integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsAssembla
/api/v4/groups/{id}/integrations/bamboo:
put:
summary: Create/Edit Bamboo integration
description: Set Bamboo integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsBamboo
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsBamboo'
responses:
'200':
description: Create/Edit Bamboo integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsBamboo
/api/v4/groups/{id}/integrations/bugzilla:
put:
summary: Create/Edit Bugzilla integration
description: Set Bugzilla integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsBugzilla
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsBugzilla'
responses:
'200':
description: Create/Edit Bugzilla integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsBugzilla
/api/v4/groups/{id}/integrations/buildkite:
put:
summary: Create/Edit Buildkite integration
description: Set Buildkite integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsBuildkite
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsBuildkite'
responses:
'200':
description: Create/Edit Buildkite integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsBuildkite
/api/v4/groups/{id}/integrations/campfire:
put:
summary: Create/Edit Campfire integration
description: Set Campfire integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsCampfire
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsCampfire'
responses:
'200':
description: Create/Edit Campfire integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsCampfire
/api/v4/groups/{id}/integrations/confluence:
put:
summary: Create/Edit Confluence integration
description: Set Confluence integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsConfluence
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsConfluence'
responses:
'200':
description: Create/Edit Confluence integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsConfluence
/api/v4/groups/{id}/integrations/custom-issue-tracker:
put:
summary: Create/Edit Custom Issue Tracker integration
description: Set Custom Issue Tracker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsCustomIssueTracker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsCustomIssueTracker'
responses:
'200':
description: Create/Edit Custom Issue Tracker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsCustomIssueTracker
/api/v4/groups/{id}/integrations/datadog:
put:
summary: Create/Edit Datadog integration
description: Set Datadog integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsDatadog
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsDatadog'
responses:
'200':
description: Create/Edit Datadog integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsDatadog
/api/v4/groups/{id}/integrations/diffblue-cover:
put:
summary: Create/Edit Diffblue Cover integration
description: Set Diffblue Cover integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsDiffblueCover
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsDiffblueCover'
responses:
'200':
description: Create/Edit Diffblue Cover integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsDiffblueCover
/api/v4/groups/{id}/integrations/discord:
put:
summary: Create/Edit Discord integration
description: Set Discord integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsDiscord
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsDiscord'
responses:
'200':
description: Create/Edit Discord integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsDiscord
/api/v4/groups/{id}/integrations/drone-ci:
put:
summary: Create/Edit Drone Ci integration
description: Set Drone Ci integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsDroneCi
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsDroneCi'
responses:
'200':
description: Create/Edit Drone Ci integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsDroneCi
/api/v4/groups/{id}/integrations/emails-on-push:
put:
summary: Create/Edit Emails On Push integration
description: Set Emails On Push integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsEmailsOnPush
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsEmailsOnPush'
responses:
'200':
description: Create/Edit Emails On Push integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsEmailsOnPush
/api/v4/groups/{id}/integrations/external-wiki:
put:
summary: Create/Edit External Wiki integration
description: Set External Wiki integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsExternalWiki
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsExternalWiki'
responses:
'200':
description: Create/Edit External Wiki integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsExternalWiki
/api/v4/groups/{id}/integrations/gitlab-slack-application:
put:
summary: Create/Edit Gitlab Slack Application integration
description: Set Gitlab Slack Application integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsGitlabSlackApplication
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsGitlabSlackApplication'
responses:
'200':
description: Create/Edit Gitlab Slack Application integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsGitlabSlackApplication
/api/v4/groups/{id}/integrations/google-play:
put:
summary: Create/Edit Google Play integration
description: Set Google Play integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsGooglePlay
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsGooglePlay'
responses:
'200':
description: Create/Edit Google Play integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsGooglePlay
/api/v4/groups/{id}/integrations/hangouts-chat:
put:
summary: Create/Edit Hangouts Chat integration
description: Set Hangouts Chat integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsHangoutsChat
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsHangoutsChat'
responses:
'200':
description: Create/Edit Hangouts Chat integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsHangoutsChat
/api/v4/groups/{id}/integrations/harbor:
put:
summary: Create/Edit Harbor integration
description: Set Harbor integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsHarbor
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsHarbor'
responses:
'200':
description: Create/Edit Harbor integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsHarbor
/api/v4/groups/{id}/integrations/irker:
put:
summary: Create/Edit Irker integration
description: Set Irker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsIrker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsIrker'
responses:
'200':
description: Create/Edit Irker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsIrker
/api/v4/groups/{id}/integrations/jenkins:
put:
summary: Create/Edit Jenkins integration
description: Set Jenkins integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsJenkins
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsJenkins'
responses:
'200':
description: Create/Edit Jenkins integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsJenkins
/api/v4/groups/{id}/integrations/jira:
put:
summary: Create/Edit Jira integration
description: Set Jira integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsJira
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsJira'
responses:
'200':
description: Create/Edit Jira integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsJira
/api/v4/groups/{id}/integrations/jira-cloud-app:
put:
summary: Create/Edit Jira Cloud App integration
description: Set Jira Cloud App integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsJiraCloudApp
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsJiraCloudApp'
responses:
'200':
description: Create/Edit Jira Cloud App integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsJiraCloudApp
/api/v4/groups/{id}/integrations/linear:
put:
summary: Create/Edit Linear integration
description: Set Linear integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsLinear
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsLinear'
responses:
'200':
description: Create/Edit Linear integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsLinear
/api/v4/groups/{id}/integrations/matrix:
put:
summary: Create/Edit Matrix integration
description: Set Matrix integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsMatrix
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsMatrix'
responses:
'200':
description: Create/Edit Matrix integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsMatrix
/api/v4/groups/{id}/integrations/mattermost-slash-commands:
put:
summary: Create/Edit Mattermost Slash Commands integration
description: Set Mattermost Slash Commands integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsMattermostSlashCommands
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsMattermostSlashCommands'
responses:
'200':
description: Create/Edit Mattermost Slash Commands integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsMattermostSlashCommands
/api/v4/groups/{id}/integrations/packagist:
put:
summary: Create/Edit Packagist integration
description: Set Packagist integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsPackagist
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsPackagist'
responses:
'200':
description: Create/Edit Packagist integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsPackagist
/api/v4/groups/{id}/integrations/phorge:
put:
summary: Create/Edit Phorge integration
description: Set Phorge integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsPhorge
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsPhorge'
responses:
'200':
description: Create/Edit Phorge integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsPhorge
/api/v4/groups/{id}/integrations/pipelines-email:
put:
summary: Create/Edit Pipelines Email integration
description: Set Pipelines Email integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsPipelinesEmail
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsPipelinesEmail'
responses:
'200':
description: Create/Edit Pipelines Email integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsPipelinesEmail
/api/v4/groups/{id}/integrations/pivotaltracker:
put:
summary: Create/Edit Pivotaltracker integration
description: Set Pivotaltracker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsPivotaltracker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsPivotaltracker'
responses:
'200':
description: Create/Edit Pivotaltracker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsPivotaltracker
/api/v4/groups/{id}/integrations/pumble:
put:
summary: Create/Edit Pumble integration
description: Set Pumble integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsPumble
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsPumble'
responses:
'200':
description: Create/Edit Pumble integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsPumble
/api/v4/groups/{id}/integrations/pushover:
put:
summary: Create/Edit Pushover integration
description: Set Pushover integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsPushover
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsPushover'
responses:
'200':
description: Create/Edit Pushover integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsPushover
/api/v4/groups/{id}/integrations/redmine:
put:
summary: Create/Edit Redmine integration
description: Set Redmine integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsRedmine
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsRedmine'
responses:
'200':
description: Create/Edit Redmine integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsRedmine
/api/v4/groups/{id}/integrations/ewm:
put:
summary: Create/Edit Ewm integration
description: Set Ewm integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsEwm
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsEwm'
responses:
'200':
description: Create/Edit Ewm integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsEwm
/api/v4/groups/{id}/integrations/youtrack:
put:
summary: Create/Edit Youtrack integration
description: Set Youtrack integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsYoutrack
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsYoutrack'
responses:
'200':
description: Create/Edit Youtrack integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsYoutrack
/api/v4/groups/{id}/integrations/clickup:
put:
summary: Create/Edit Clickup integration
description: Set Clickup integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsClickup
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsClickup'
responses:
'200':
description: Create/Edit Clickup integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsClickup
/api/v4/groups/{id}/integrations/slack:
put:
summary: Create/Edit Slack integration
description: Set Slack integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsSlack
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsSlack'
responses:
'200':
description: Create/Edit Slack integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsSlack
/api/v4/groups/{id}/integrations/microsoft-teams:
put:
summary: Create/Edit Microsoft Teams integration
description: Set Microsoft Teams integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsMicrosoftTeams
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsMicrosoftTeams'
responses:
'200':
description: Create/Edit Microsoft Teams integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsMicrosoftTeams
/api/v4/groups/{id}/integrations/mattermost:
put:
summary: Create/Edit Mattermost integration
description: Set Mattermost integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsMattermost
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsMattermost'
responses:
'200':
description: Create/Edit Mattermost integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsMattermost
/api/v4/groups/{id}/integrations/teamcity:
put:
summary: Create/Edit Teamcity integration
description: Set Teamcity integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsTeamcity
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsTeamcity'
responses:
'200':
description: Create/Edit Teamcity integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsTeamcity
/api/v4/groups/{id}/integrations/telegram:
put:
summary: Create/Edit Telegram integration
description: Set Telegram integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsTelegram
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsTelegram'
responses:
'200':
description: Create/Edit Telegram integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsTelegram
/api/v4/groups/{id}/integrations/unify-circuit:
put:
summary: Create/Edit Unify Circuit integration
description: Set Unify Circuit integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsUnifyCircuit
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsUnifyCircuit'
responses:
'200':
description: Create/Edit Unify Circuit integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsUnifyCircuit
/api/v4/groups/{id}/integrations/webex-teams:
put:
summary: Create/Edit Webex Teams integration
description: Set Webex Teams integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsWebexTeams
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsWebexTeams'
responses:
'200':
description: Create/Edit Webex Teams integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsWebexTeams
/api/v4/groups/{id}/integrations/zentao:
put:
summary: Create/Edit Zentao integration
description: Set Zentao integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsZentao
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsZentao'
responses:
'200':
description: Create/Edit Zentao integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsZentao
/api/v4/groups/{id}/integrations/squash-tm:
put:
summary: Create/Edit Squash Tm integration
description: Set Squash Tm integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsSquashTm
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsSquashTm'
responses:
'200':
description: Create/Edit Squash Tm integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsSquashTm
/api/v4/groups/{id}/integrations/github:
put:
summary: Create/Edit Github integration
description: Set Github integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsGithub
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsGithub'
responses:
'200':
description: Create/Edit Github integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsGithub
/api/v4/groups/{id}/integrations/git-guardian:
put:
summary: Create/Edit Git Guardian integration
description: Set Git Guardian integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsGitGuardian
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsGitGuardian'
responses:
'200':
description: Create/Edit Git Guardian integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsGitGuardian
/api/v4/groups/{id}/integrations/google-cloud-platform-artifact-registry:
put:
summary: Create/Edit Google Cloud Platform Artifact Registry integration
description: Set Google Cloud Platform Artifact Registry integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsGoogleCloudPlatformArtifactRegistry
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsGoogleCloudPlatformArtifactRegistry'
responses:
'200':
description: Create/Edit Google Cloud Platform Artifact Registry integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsGoogleCloudPlatformArtifactRegistry
/api/v4/groups/{id}/integrations/google-cloud-platform-workload-identity-federation:
put:
summary: Create/Edit Google Cloud Platform Workload Identity Federation integration
description: Set Google Cloud Platform Workload Identity Federation integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation'
responses:
'200':
description: Create/Edit Google Cloud Platform Workload Identity Federation integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation
/api/v4/groups/{id}/integrations/mock-ci:
put:
summary: Create/Edit Mock Ci integration
description: Set Mock Ci integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsMockCi
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsMockCi'
responses:
'200':
description: Create/Edit Mock Ci integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsMockCi
/api/v4/groups/{id}/integrations/mock-monitoring:
put:
summary: Create/Edit Mock Monitoring integration
description: Set Mock Monitoring integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4GroupsIdIntegrationsMockMonitoring
in: body
required: true
schema:
$ref: '#/definitions/putApiV4GroupsIdIntegrationsMockMonitoring'
responses:
'200':
description: Create/Edit Mock Monitoring integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4GroupsIdIntegrationsMockMonitoring
/api/v4/groups/{id}/integrations/{slug}:
delete:
summary: Disable an integration
description: Disable the integration. Integration settings are preserved.
produces:
- application/json
parameters:
- in: path
name: slug
description: The name of the integration
type: string
enum:
- apple-app-store
- asana
- assembla
- bamboo
- bugzilla
- buildkite
- campfire
- confluence
- custom-issue-tracker
- datadog
- diffblue-cover
- discord
- drone-ci
- emails-on-push
- external-wiki
- gitlab-slack-application
- google-play
- hangouts-chat
- harbor
- irker
- jenkins
- jira
- jira-cloud-app
- linear
- matrix
- mattermost-slash-commands
- packagist
- phorge
- pipelines-email
- pivotaltracker
- pumble
- pushover
- redmine
- ewm
- youtrack
- clickup
- slack
- microsoft-teams
- mattermost
- teamcity
- telegram
- unify-circuit
- webex-teams
- zentao
- squash-tm
- github
- git-guardian
- google-cloud-platform-artifact-registry
- google-cloud-platform-workload-identity-federation
- mock-ci
- mock-monitoring
required: true
- in: path
name: id
type: integer
format: int32
required: true
responses:
'204':
description: Disable an integration
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: deleteApiV4GroupsIdIntegrationsSlug
get:
summary: Get an integration settings
description: Get the integration settings.
produces:
- application/json
parameters:
- in: path
name: slug
description: The name of the integration
type: string
enum:
- apple-app-store
- asana
- assembla
- bamboo
- bugzilla
- buildkite
- campfire
- confluence
- custom-issue-tracker
- datadog
- diffblue-cover
- discord
- drone-ci
- emails-on-push
- external-wiki
- gitlab-slack-application
- google-play
- hangouts-chat
- harbor
- irker
- jenkins
- jira
- jira-cloud-app
- linear
- matrix
- mattermost-slash-commands
- packagist
- phorge
- pipelines-email
- pivotaltracker
- pumble
- pushover
- redmine
- ewm
- youtrack
- clickup
- slack
- microsoft-teams
- mattermost
- teamcity
- telegram
- unify-circuit
- webex-teams
- zentao
- squash-tm
- github
- git-guardian
- google-cloud-platform-artifact-registry
- google-cloud-platform-workload-identity-federation
- mock-ci
- mock-monitoring
required: true
- in: path
name: id
type: integer
format: int32
required: true
responses:
'200':
description: Get an integration settings
schema:
$ref: '#/definitions/API_Entities_Integration'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: getApiV4GroupsIdIntegrationsSlug
/api/v4/projects/{id}/services:
get:
summary: List all active integrations
description: Get a list of all active integrations.
produces:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
responses:
'200':
description: List all active integrations
schema:
type: array
items:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: getApiV4ProjectsIdServices
/api/v4/projects/{id}/services/apple-app-store:
put:
summary: Create/Edit Apple App Store integration
description: Set Apple App Store integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesAppleAppStore
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesAppleAppStore'
responses:
'200':
description: Create/Edit Apple App Store integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesAppleAppStore
/api/v4/projects/{id}/services/asana:
put:
summary: Create/Edit Asana integration
description: Set Asana integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesAsana
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesAsana'
responses:
'200':
description: Create/Edit Asana integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesAsana
/api/v4/projects/{id}/services/assembla:
put:
summary: Create/Edit Assembla integration
description: Set Assembla integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesAssembla
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesAssembla'
responses:
'200':
description: Create/Edit Assembla integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesAssembla
/api/v4/projects/{id}/services/bamboo:
put:
summary: Create/Edit Bamboo integration
description: Set Bamboo integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesBamboo
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesBamboo'
responses:
'200':
description: Create/Edit Bamboo integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesBamboo
/api/v4/projects/{id}/services/bugzilla:
put:
summary: Create/Edit Bugzilla integration
description: Set Bugzilla integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesBugzilla
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesBugzilla'
responses:
'200':
description: Create/Edit Bugzilla integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesBugzilla
/api/v4/projects/{id}/services/buildkite:
put:
summary: Create/Edit Buildkite integration
description: Set Buildkite integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesBuildkite
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesBuildkite'
responses:
'200':
description: Create/Edit Buildkite integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesBuildkite
/api/v4/projects/{id}/services/campfire:
put:
summary: Create/Edit Campfire integration
description: Set Campfire integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesCampfire
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesCampfire'
responses:
'200':
description: Create/Edit Campfire integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesCampfire
/api/v4/projects/{id}/services/confluence:
put:
summary: Create/Edit Confluence integration
description: Set Confluence integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesConfluence
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesConfluence'
responses:
'200':
description: Create/Edit Confluence integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesConfluence
/api/v4/projects/{id}/services/custom-issue-tracker:
put:
summary: Create/Edit Custom Issue Tracker integration
description: Set Custom Issue Tracker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesCustomIssueTracker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesCustomIssueTracker'
responses:
'200':
description: Create/Edit Custom Issue Tracker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesCustomIssueTracker
/api/v4/projects/{id}/services/datadog:
put:
summary: Create/Edit Datadog integration
description: Set Datadog integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesDatadog
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesDatadog'
responses:
'200':
description: Create/Edit Datadog integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesDatadog
/api/v4/projects/{id}/services/diffblue-cover:
put:
summary: Create/Edit Diffblue Cover integration
description: Set Diffblue Cover integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesDiffblueCover
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesDiffblueCover'
responses:
'200':
description: Create/Edit Diffblue Cover integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesDiffblueCover
/api/v4/projects/{id}/services/discord:
put:
summary: Create/Edit Discord integration
description: Set Discord integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesDiscord
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesDiscord'
responses:
'200':
description: Create/Edit Discord integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesDiscord
/api/v4/projects/{id}/services/drone-ci:
put:
summary: Create/Edit Drone Ci integration
description: Set Drone Ci integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesDroneCi
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesDroneCi'
responses:
'200':
description: Create/Edit Drone Ci integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesDroneCi
/api/v4/projects/{id}/services/emails-on-push:
put:
summary: Create/Edit Emails On Push integration
description: Set Emails On Push integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesEmailsOnPush
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesEmailsOnPush'
responses:
'200':
description: Create/Edit Emails On Push integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesEmailsOnPush
/api/v4/projects/{id}/services/external-wiki:
put:
summary: Create/Edit External Wiki integration
description: Set External Wiki integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesExternalWiki
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesExternalWiki'
responses:
'200':
description: Create/Edit External Wiki integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesExternalWiki
/api/v4/projects/{id}/services/gitlab-slack-application:
put:
summary: Create/Edit Gitlab Slack Application integration
description: Set Gitlab Slack Application integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesGitlabSlackApplication
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesGitlabSlackApplication'
responses:
'200':
description: Create/Edit Gitlab Slack Application integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesGitlabSlackApplication
/api/v4/projects/{id}/services/google-play:
put:
summary: Create/Edit Google Play integration
description: Set Google Play integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesGooglePlay
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesGooglePlay'
responses:
'200':
description: Create/Edit Google Play integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesGooglePlay
/api/v4/projects/{id}/services/hangouts-chat:
put:
summary: Create/Edit Hangouts Chat integration
description: Set Hangouts Chat integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesHangoutsChat
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesHangoutsChat'
responses:
'200':
description: Create/Edit Hangouts Chat integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesHangoutsChat
/api/v4/projects/{id}/services/harbor:
put:
summary: Create/Edit Harbor integration
description: Set Harbor integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesHarbor
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesHarbor'
responses:
'200':
description: Create/Edit Harbor integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesHarbor
/api/v4/projects/{id}/services/irker:
put:
summary: Create/Edit Irker integration
description: Set Irker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesIrker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesIrker'
responses:
'200':
description: Create/Edit Irker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesIrker
/api/v4/projects/{id}/services/jenkins:
put:
summary: Create/Edit Jenkins integration
description: Set Jenkins integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesJenkins
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesJenkins'
responses:
'200':
description: Create/Edit Jenkins integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesJenkins
/api/v4/projects/{id}/services/jira:
put:
summary: Create/Edit Jira integration
description: Set Jira integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesJira
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesJira'
responses:
'200':
description: Create/Edit Jira integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesJira
/api/v4/projects/{id}/services/jira-cloud-app:
put:
summary: Create/Edit Jira Cloud App integration
description: Set Jira Cloud App integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesJiraCloudApp
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesJiraCloudApp'
responses:
'200':
description: Create/Edit Jira Cloud App integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesJiraCloudApp
/api/v4/projects/{id}/services/linear:
put:
summary: Create/Edit Linear integration
description: Set Linear integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesLinear
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesLinear'
responses:
'200':
description: Create/Edit Linear integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesLinear
/api/v4/projects/{id}/services/matrix:
put:
summary: Create/Edit Matrix integration
description: Set Matrix integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesMatrix
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesMatrix'
responses:
'200':
description: Create/Edit Matrix integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesMatrix
/api/v4/projects/{id}/services/mattermost-slash-commands:
put:
summary: Create/Edit Mattermost Slash Commands integration
description: Set Mattermost Slash Commands integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesMattermostSlashCommands
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesMattermostSlashCommands'
responses:
'200':
description: Create/Edit Mattermost Slash Commands integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesMattermostSlashCommands
/api/v4/projects/{id}/services/packagist:
put:
summary: Create/Edit Packagist integration
description: Set Packagist integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesPackagist
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesPackagist'
responses:
'200':
description: Create/Edit Packagist integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesPackagist
/api/v4/projects/{id}/services/phorge:
put:
summary: Create/Edit Phorge integration
description: Set Phorge integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesPhorge
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesPhorge'
responses:
'200':
description: Create/Edit Phorge integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesPhorge
/api/v4/projects/{id}/services/pipelines-email:
put:
summary: Create/Edit Pipelines Email integration
description: Set Pipelines Email integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesPipelinesEmail
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesPipelinesEmail'
responses:
'200':
description: Create/Edit Pipelines Email integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesPipelinesEmail
/api/v4/projects/{id}/services/pivotaltracker:
put:
summary: Create/Edit Pivotaltracker integration
description: Set Pivotaltracker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesPivotaltracker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesPivotaltracker'
responses:
'200':
description: Create/Edit Pivotaltracker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesPivotaltracker
/api/v4/projects/{id}/services/pumble:
put:
summary: Create/Edit Pumble integration
description: Set Pumble integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesPumble
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesPumble'
responses:
'200':
description: Create/Edit Pumble integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesPumble
/api/v4/projects/{id}/services/pushover:
put:
summary: Create/Edit Pushover integration
description: Set Pushover integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesPushover
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesPushover'
responses:
'200':
description: Create/Edit Pushover integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesPushover
/api/v4/projects/{id}/services/redmine:
put:
summary: Create/Edit Redmine integration
description: Set Redmine integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesRedmine
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesRedmine'
responses:
'200':
description: Create/Edit Redmine integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesRedmine
/api/v4/projects/{id}/services/ewm:
put:
summary: Create/Edit Ewm integration
description: Set Ewm integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesEwm
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesEwm'
responses:
'200':
description: Create/Edit Ewm integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesEwm
/api/v4/projects/{id}/services/youtrack:
put:
summary: Create/Edit Youtrack integration
description: Set Youtrack integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesYoutrack
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesYoutrack'
responses:
'200':
description: Create/Edit Youtrack integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesYoutrack
/api/v4/projects/{id}/services/clickup:
put:
summary: Create/Edit Clickup integration
description: Set Clickup integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesClickup
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesClickup'
responses:
'200':
description: Create/Edit Clickup integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesClickup
/api/v4/projects/{id}/services/slack:
put:
summary: Create/Edit Slack integration
description: Set Slack integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesSlack
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesSlack'
responses:
'200':
description: Create/Edit Slack integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesSlack
/api/v4/projects/{id}/services/microsoft-teams:
put:
summary: Create/Edit Microsoft Teams integration
description: Set Microsoft Teams integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesMicrosoftTeams
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesMicrosoftTeams'
responses:
'200':
description: Create/Edit Microsoft Teams integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesMicrosoftTeams
/api/v4/projects/{id}/services/mattermost:
put:
summary: Create/Edit Mattermost integration
description: Set Mattermost integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesMattermost
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesMattermost'
responses:
'200':
description: Create/Edit Mattermost integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesMattermost
/api/v4/projects/{id}/services/teamcity:
put:
summary: Create/Edit Teamcity integration
description: Set Teamcity integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesTeamcity
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesTeamcity'
responses:
'200':
description: Create/Edit Teamcity integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesTeamcity
/api/v4/projects/{id}/services/telegram:
put:
summary: Create/Edit Telegram integration
description: Set Telegram integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesTelegram
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesTelegram'
responses:
'200':
description: Create/Edit Telegram integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesTelegram
/api/v4/projects/{id}/services/unify-circuit:
put:
summary: Create/Edit Unify Circuit integration
description: Set Unify Circuit integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesUnifyCircuit
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesUnifyCircuit'
responses:
'200':
description: Create/Edit Unify Circuit integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesUnifyCircuit
/api/v4/projects/{id}/services/webex-teams:
put:
summary: Create/Edit Webex Teams integration
description: Set Webex Teams integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesWebexTeams
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesWebexTeams'
responses:
'200':
description: Create/Edit Webex Teams integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesWebexTeams
/api/v4/projects/{id}/services/zentao:
put:
summary: Create/Edit Zentao integration
description: Set Zentao integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesZentao
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesZentao'
responses:
'200':
description: Create/Edit Zentao integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesZentao
/api/v4/projects/{id}/services/squash-tm:
put:
summary: Create/Edit Squash Tm integration
description: Set Squash Tm integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesSquashTm
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesSquashTm'
responses:
'200':
description: Create/Edit Squash Tm integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesSquashTm
/api/v4/projects/{id}/services/github:
put:
summary: Create/Edit Github integration
description: Set Github integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesGithub
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesGithub'
responses:
'200':
description: Create/Edit Github integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesGithub
/api/v4/projects/{id}/services/git-guardian:
put:
summary: Create/Edit Git Guardian integration
description: Set Git Guardian integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesGitGuardian
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesGitGuardian'
responses:
'200':
description: Create/Edit Git Guardian integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesGitGuardian
/api/v4/projects/{id}/services/google-cloud-platform-artifact-registry:
put:
summary: Create/Edit Google Cloud Platform Artifact Registry integration
description: Set Google Cloud Platform Artifact Registry integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesGoogleCloudPlatformArtifactRegistry
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesGoogleCloudPlatformArtifactRegistry'
responses:
'200':
description: Create/Edit Google Cloud Platform Artifact Registry integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesGoogleCloudPlatformArtifactRegistry
/api/v4/projects/{id}/services/google-cloud-platform-workload-identity-federation:
put:
summary: Create/Edit Google Cloud Platform Workload Identity Federation integration
description: Set Google Cloud Platform Workload Identity Federation integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesGoogleCloudPlatformWorkloadIdentityFederation
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesGoogleCloudPlatformWorkloadIdentityFederation'
responses:
'200':
description: Create/Edit Google Cloud Platform Workload Identity Federation integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesGoogleCloudPlatformWorkloadIdentityFederation
/api/v4/projects/{id}/services/mock-ci:
put:
summary: Create/Edit Mock Ci integration
description: Set Mock Ci integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesMockCi
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesMockCi'
responses:
'200':
description: Create/Edit Mock Ci integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesMockCi
/api/v4/projects/{id}/services/mock-monitoring:
put:
summary: Create/Edit Mock Monitoring integration
description: Set Mock Monitoring integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdServicesMockMonitoring
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdServicesMockMonitoring'
responses:
'200':
description: Create/Edit Mock Monitoring integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdServicesMockMonitoring
/api/v4/projects/{id}/services/{slug}:
delete:
summary: Disable an integration
description: Disable the integration. Integration settings are preserved.
produces:
- application/json
parameters:
- in: path
name: slug
description: The name of the integration
type: string
enum:
- apple-app-store
- asana
- assembla
- bamboo
- bugzilla
- buildkite
- campfire
- confluence
- custom-issue-tracker
- datadog
- diffblue-cover
- discord
- drone-ci
- emails-on-push
- external-wiki
- gitlab-slack-application
- google-play
- hangouts-chat
- harbor
- irker
- jenkins
- jira
- jira-cloud-app
- linear
- matrix
- mattermost-slash-commands
- packagist
- phorge
- pipelines-email
- pivotaltracker
- pumble
- pushover
- redmine
- ewm
- youtrack
- clickup
- slack
- microsoft-teams
- mattermost
- teamcity
- telegram
- unify-circuit
- webex-teams
- zentao
- squash-tm
- github
- git-guardian
- google-cloud-platform-artifact-registry
- google-cloud-platform-workload-identity-federation
- mock-ci
- mock-monitoring
required: true
- in: path
name: id
type: integer
format: int32
required: true
responses:
'204':
description: Disable an integration
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: deleteApiV4ProjectsIdServicesSlug
get:
summary: Get an integration settings
description: Get the integration settings.
produces:
- application/json
parameters:
- in: path
name: slug
description: The name of the integration
type: string
enum:
- apple-app-store
- asana
- assembla
- bamboo
- bugzilla
- buildkite
- campfire
- confluence
- custom-issue-tracker
- datadog
- diffblue-cover
- discord
- drone-ci
- emails-on-push
- external-wiki
- gitlab-slack-application
- google-play
- hangouts-chat
- harbor
- irker
- jenkins
- jira
- jira-cloud-app
- linear
- matrix
- mattermost-slash-commands
- packagist
- phorge
- pipelines-email
- pivotaltracker
- pumble
- pushover
- redmine
- ewm
- youtrack
- clickup
- slack
- microsoft-teams
- mattermost
- teamcity
- telegram
- unify-circuit
- webex-teams
- zentao
- squash-tm
- github
- git-guardian
- google-cloud-platform-artifact-registry
- google-cloud-platform-workload-identity-federation
- mock-ci
- mock-monitoring
required: true
- in: path
name: id
type: integer
format: int32
required: true
responses:
'200':
description: Get an integration settings
schema:
$ref: '#/definitions/API_Entities_Integration'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: getApiV4ProjectsIdServicesSlug
/api/v4/projects/{id}/services/mattermost_slash_commands/trigger:
post:
summary: Trigger a slash command for mattermost-slash-commands
description: Added in GitLab 8.13
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project
type: string
required: true
- name: postApiV4ProjectsIdServicesMattermostSlashCommandsTrigger
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdServicesMattermostSlashCommandsTrigger'
responses:
'201':
description: Trigger a slash command for mattermost-slash-commands
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: postApiV4ProjectsIdServicesMattermostSlashCommandsTrigger
/api/v4/projects/{id}/integrations:
get:
summary: List all active integrations
description: Get a list of all active integrations.
produces:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
responses:
'200':
description: List all active integrations
schema:
type: array
items:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: getApiV4ProjectsIdIntegrations
/api/v4/projects/{id}/integrations/apple-app-store:
put:
summary: Create/Edit Apple App Store integration
description: Set Apple App Store integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsAppleAppStore
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsAppleAppStore'
responses:
'200':
description: Create/Edit Apple App Store integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsAppleAppStore
/api/v4/projects/{id}/integrations/asana:
put:
summary: Create/Edit Asana integration
description: Set Asana integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsAsana
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsAsana'
responses:
'200':
description: Create/Edit Asana integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsAsana
/api/v4/projects/{id}/integrations/assembla:
put:
summary: Create/Edit Assembla integration
description: Set Assembla integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsAssembla
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsAssembla'
responses:
'200':
description: Create/Edit Assembla integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsAssembla
/api/v4/projects/{id}/integrations/bamboo:
put:
summary: Create/Edit Bamboo integration
description: Set Bamboo integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsBamboo
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsBamboo'
responses:
'200':
description: Create/Edit Bamboo integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsBamboo
/api/v4/projects/{id}/integrations/bugzilla:
put:
summary: Create/Edit Bugzilla integration
description: Set Bugzilla integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsBugzilla
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsBugzilla'
responses:
'200':
description: Create/Edit Bugzilla integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsBugzilla
/api/v4/projects/{id}/integrations/buildkite:
put:
summary: Create/Edit Buildkite integration
description: Set Buildkite integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsBuildkite
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsBuildkite'
responses:
'200':
description: Create/Edit Buildkite integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsBuildkite
/api/v4/projects/{id}/integrations/campfire:
put:
summary: Create/Edit Campfire integration
description: Set Campfire integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsCampfire
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsCampfire'
responses:
'200':
description: Create/Edit Campfire integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsCampfire
/api/v4/projects/{id}/integrations/confluence:
put:
summary: Create/Edit Confluence integration
description: Set Confluence integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsConfluence
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsConfluence'
responses:
'200':
description: Create/Edit Confluence integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsConfluence
/api/v4/projects/{id}/integrations/custom-issue-tracker:
put:
summary: Create/Edit Custom Issue Tracker integration
description: Set Custom Issue Tracker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsCustomIssueTracker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsCustomIssueTracker'
responses:
'200':
description: Create/Edit Custom Issue Tracker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsCustomIssueTracker
/api/v4/projects/{id}/integrations/datadog:
put:
summary: Create/Edit Datadog integration
description: Set Datadog integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsDatadog
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsDatadog'
responses:
'200':
description: Create/Edit Datadog integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsDatadog
/api/v4/projects/{id}/integrations/diffblue-cover:
put:
summary: Create/Edit Diffblue Cover integration
description: Set Diffblue Cover integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsDiffblueCover
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsDiffblueCover'
responses:
'200':
description: Create/Edit Diffblue Cover integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsDiffblueCover
/api/v4/projects/{id}/integrations/discord:
put:
summary: Create/Edit Discord integration
description: Set Discord integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsDiscord
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsDiscord'
responses:
'200':
description: Create/Edit Discord integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsDiscord
/api/v4/projects/{id}/integrations/drone-ci:
put:
summary: Create/Edit Drone Ci integration
description: Set Drone Ci integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsDroneCi
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsDroneCi'
responses:
'200':
description: Create/Edit Drone Ci integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsDroneCi
/api/v4/projects/{id}/integrations/emails-on-push:
put:
summary: Create/Edit Emails On Push integration
description: Set Emails On Push integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsEmailsOnPush
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsEmailsOnPush'
responses:
'200':
description: Create/Edit Emails On Push integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsEmailsOnPush
/api/v4/projects/{id}/integrations/external-wiki:
put:
summary: Create/Edit External Wiki integration
description: Set External Wiki integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsExternalWiki
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsExternalWiki'
responses:
'200':
description: Create/Edit External Wiki integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsExternalWiki
/api/v4/projects/{id}/integrations/gitlab-slack-application:
put:
summary: Create/Edit Gitlab Slack Application integration
description: Set Gitlab Slack Application integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsGitlabSlackApplication
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsGitlabSlackApplication'
responses:
'200':
description: Create/Edit Gitlab Slack Application integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsGitlabSlackApplication
/api/v4/projects/{id}/integrations/google-play:
put:
summary: Create/Edit Google Play integration
description: Set Google Play integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsGooglePlay
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsGooglePlay'
responses:
'200':
description: Create/Edit Google Play integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsGooglePlay
/api/v4/projects/{id}/integrations/hangouts-chat:
put:
summary: Create/Edit Hangouts Chat integration
description: Set Hangouts Chat integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsHangoutsChat
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsHangoutsChat'
responses:
'200':
description: Create/Edit Hangouts Chat integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsHangoutsChat
/api/v4/projects/{id}/integrations/harbor:
put:
summary: Create/Edit Harbor integration
description: Set Harbor integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsHarbor
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsHarbor'
responses:
'200':
description: Create/Edit Harbor integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsHarbor
/api/v4/projects/{id}/integrations/irker:
put:
summary: Create/Edit Irker integration
description: Set Irker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsIrker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsIrker'
responses:
'200':
description: Create/Edit Irker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsIrker
/api/v4/projects/{id}/integrations/jenkins:
put:
summary: Create/Edit Jenkins integration
description: Set Jenkins integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsJenkins
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsJenkins'
responses:
'200':
description: Create/Edit Jenkins integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsJenkins
/api/v4/projects/{id}/integrations/jira:
put:
summary: Create/Edit Jira integration
description: Set Jira integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsJira
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsJira'
responses:
'200':
description: Create/Edit Jira integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsJira
/api/v4/projects/{id}/integrations/jira-cloud-app:
put:
summary: Create/Edit Jira Cloud App integration
description: Set Jira Cloud App integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsJiraCloudApp
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsJiraCloudApp'
responses:
'200':
description: Create/Edit Jira Cloud App integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsJiraCloudApp
/api/v4/projects/{id}/integrations/linear:
put:
summary: Create/Edit Linear integration
description: Set Linear integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsLinear
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsLinear'
responses:
'200':
description: Create/Edit Linear integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsLinear
/api/v4/projects/{id}/integrations/matrix:
put:
summary: Create/Edit Matrix integration
description: Set Matrix integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsMatrix
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsMatrix'
responses:
'200':
description: Create/Edit Matrix integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsMatrix
/api/v4/projects/{id}/integrations/mattermost-slash-commands:
put:
summary: Create/Edit Mattermost Slash Commands integration
description: Set Mattermost Slash Commands integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsMattermostSlashCommands
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsMattermostSlashCommands'
responses:
'200':
description: Create/Edit Mattermost Slash Commands integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsMattermostSlashCommands
/api/v4/projects/{id}/integrations/packagist:
put:
summary: Create/Edit Packagist integration
description: Set Packagist integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsPackagist
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsPackagist'
responses:
'200':
description: Create/Edit Packagist integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsPackagist
/api/v4/projects/{id}/integrations/phorge:
put:
summary: Create/Edit Phorge integration
description: Set Phorge integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsPhorge
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsPhorge'
responses:
'200':
description: Create/Edit Phorge integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsPhorge
/api/v4/projects/{id}/integrations/pipelines-email:
put:
summary: Create/Edit Pipelines Email integration
description: Set Pipelines Email integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsPipelinesEmail
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsPipelinesEmail'
responses:
'200':
description: Create/Edit Pipelines Email integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsPipelinesEmail
/api/v4/projects/{id}/integrations/pivotaltracker:
put:
summary: Create/Edit Pivotaltracker integration
description: Set Pivotaltracker integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsPivotaltracker
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsPivotaltracker'
responses:
'200':
description: Create/Edit Pivotaltracker integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsPivotaltracker
/api/v4/projects/{id}/integrations/pumble:
put:
summary: Create/Edit Pumble integration
description: Set Pumble integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsPumble
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsPumble'
responses:
'200':
description: Create/Edit Pumble integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsPumble
/api/v4/projects/{id}/integrations/pushover:
put:
summary: Create/Edit Pushover integration
description: Set Pushover integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsPushover
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsPushover'
responses:
'200':
description: Create/Edit Pushover integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsPushover
/api/v4/projects/{id}/integrations/redmine:
put:
summary: Create/Edit Redmine integration
description: Set Redmine integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsRedmine
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsRedmine'
responses:
'200':
description: Create/Edit Redmine integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsRedmine
/api/v4/projects/{id}/integrations/ewm:
put:
summary: Create/Edit Ewm integration
description: Set Ewm integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsEwm
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsEwm'
responses:
'200':
description: Create/Edit Ewm integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsEwm
/api/v4/projects/{id}/integrations/youtrack:
put:
summary: Create/Edit Youtrack integration
description: Set Youtrack integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsYoutrack
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsYoutrack'
responses:
'200':
description: Create/Edit Youtrack integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsYoutrack
/api/v4/projects/{id}/integrations/clickup:
put:
summary: Create/Edit Clickup integration
description: Set Clickup integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsClickup
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsClickup'
responses:
'200':
description: Create/Edit Clickup integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsClickup
/api/v4/projects/{id}/integrations/slack:
put:
summary: Create/Edit Slack integration
description: Set Slack integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsSlack
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsSlack'
responses:
'200':
description: Create/Edit Slack integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsSlack
/api/v4/projects/{id}/integrations/microsoft-teams:
put:
summary: Create/Edit Microsoft Teams integration
description: Set Microsoft Teams integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsMicrosoftTeams
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsMicrosoftTeams'
responses:
'200':
description: Create/Edit Microsoft Teams integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsMicrosoftTeams
/api/v4/projects/{id}/integrations/mattermost:
put:
summary: Create/Edit Mattermost integration
description: Set Mattermost integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsMattermost
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsMattermost'
responses:
'200':
description: Create/Edit Mattermost integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsMattermost
/api/v4/projects/{id}/integrations/teamcity:
put:
summary: Create/Edit Teamcity integration
description: Set Teamcity integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsTeamcity
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsTeamcity'
responses:
'200':
description: Create/Edit Teamcity integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsTeamcity
/api/v4/projects/{id}/integrations/telegram:
put:
summary: Create/Edit Telegram integration
description: Set Telegram integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsTelegram
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsTelegram'
responses:
'200':
description: Create/Edit Telegram integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsTelegram
/api/v4/projects/{id}/integrations/unify-circuit:
put:
summary: Create/Edit Unify Circuit integration
description: Set Unify Circuit integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsUnifyCircuit
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsUnifyCircuit'
responses:
'200':
description: Create/Edit Unify Circuit integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsUnifyCircuit
/api/v4/projects/{id}/integrations/webex-teams:
put:
summary: Create/Edit Webex Teams integration
description: Set Webex Teams integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsWebexTeams
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsWebexTeams'
responses:
'200':
description: Create/Edit Webex Teams integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsWebexTeams
/api/v4/projects/{id}/integrations/zentao:
put:
summary: Create/Edit Zentao integration
description: Set Zentao integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsZentao
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsZentao'
responses:
'200':
description: Create/Edit Zentao integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsZentao
/api/v4/projects/{id}/integrations/squash-tm:
put:
summary: Create/Edit Squash Tm integration
description: Set Squash Tm integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsSquashTm
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsSquashTm'
responses:
'200':
description: Create/Edit Squash Tm integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsSquashTm
/api/v4/projects/{id}/integrations/github:
put:
summary: Create/Edit Github integration
description: Set Github integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsGithub
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsGithub'
responses:
'200':
description: Create/Edit Github integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsGithub
/api/v4/projects/{id}/integrations/git-guardian:
put:
summary: Create/Edit Git Guardian integration
description: Set Git Guardian integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsGitGuardian
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsGitGuardian'
responses:
'200':
description: Create/Edit Git Guardian integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsGitGuardian
/api/v4/projects/{id}/integrations/google-cloud-platform-artifact-registry:
put:
summary: Create/Edit Google Cloud Platform Artifact Registry integration
description: Set Google Cloud Platform Artifact Registry integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsGoogleCloudPlatformArtifactRegistry
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsGoogleCloudPlatformArtifactRegistry'
responses:
'200':
description: Create/Edit Google Cloud Platform Artifact Registry integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsGoogleCloudPlatformArtifactRegistry
/api/v4/projects/{id}/integrations/google-cloud-platform-workload-identity-federation:
put:
summary: Create/Edit Google Cloud Platform Workload Identity Federation integration
description: Set Google Cloud Platform Workload Identity Federation integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation'
responses:
'200':
description: Create/Edit Google Cloud Platform Workload Identity Federation integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation
/api/v4/projects/{id}/integrations/mock-ci:
put:
summary: Create/Edit Mock Ci integration
description: Set Mock Ci integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsMockCi
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsMockCi'
responses:
'200':
description: Create/Edit Mock Ci integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsMockCi
/api/v4/projects/{id}/integrations/mock-monitoring:
put:
summary: Create/Edit Mock Monitoring integration
description: Set Mock Monitoring integration.
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- name: putApiV4ProjectsIdIntegrationsMockMonitoring
in: body
required: true
schema:
$ref: '#/definitions/putApiV4ProjectsIdIntegrationsMockMonitoring'
responses:
'200':
description: Create/Edit Mock Monitoring integration
schema:
$ref: '#/definitions/API_Entities_IntegrationBasic'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
'422':
description: Unprocessable entity
tags:
- integrations
operationId: putApiV4ProjectsIdIntegrationsMockMonitoring
/api/v4/projects/{id}/integrations/{slug}:
delete:
summary: Disable an integration
description: Disable the integration. Integration settings are preserved.
produces:
- application/json
parameters:
- in: path
name: slug
description: The name of the integration
type: string
enum:
- apple-app-store
- asana
- assembla
- bamboo
- bugzilla
- buildkite
- campfire
- confluence
- custom-issue-tracker
- datadog
- diffblue-cover
- discord
- drone-ci
- emails-on-push
- external-wiki
- gitlab-slack-application
- google-play
- hangouts-chat
- harbor
- irker
- jenkins
- jira
- jira-cloud-app
- linear
- matrix
- mattermost-slash-commands
- packagist
- phorge
- pipelines-email
- pivotaltracker
- pumble
- pushover
- redmine
- ewm
- youtrack
- clickup
- slack
- microsoft-teams
- mattermost
- teamcity
- telegram
- unify-circuit
- webex-teams
- zentao
- squash-tm
- github
- git-guardian
- google-cloud-platform-artifact-registry
- google-cloud-platform-workload-identity-federation
- mock-ci
- mock-monitoring
required: true
- in: path
name: id
type: integer
format: int32
required: true
responses:
'204':
description: Disable an integration
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: deleteApiV4ProjectsIdIntegrationsSlug
get:
summary: Get an integration settings
description: Get the integration settings.
produces:
- application/json
parameters:
- in: path
name: slug
description: The name of the integration
type: string
enum:
- apple-app-store
- asana
- assembla
- bamboo
- bugzilla
- buildkite
- campfire
- confluence
- custom-issue-tracker
- datadog
- diffblue-cover
- discord
- drone-ci
- emails-on-push
- external-wiki
- gitlab-slack-application
- google-play
- hangouts-chat
- harbor
- irker
- jenkins
- jira
- jira-cloud-app
- linear
- matrix
- mattermost-slash-commands
- packagist
- phorge
- pipelines-email
- pivotaltracker
- pumble
- pushover
- redmine
- ewm
- youtrack
- clickup
- slack
- microsoft-teams
- mattermost
- teamcity
- telegram
- unify-circuit
- webex-teams
- zentao
- squash-tm
- github
- git-guardian
- google-cloud-platform-artifact-registry
- google-cloud-platform-workload-identity-federation
- mock-ci
- mock-monitoring
required: true
- in: path
name: id
type: integer
format: int32
required: true
responses:
'200':
description: Get an integration settings
schema:
$ref: '#/definitions/API_Entities_Integration'
'400':
description: Bad request
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: getApiV4ProjectsIdIntegrationsSlug
/api/v4/projects/{id}/integrations/mattermost_slash_commands/trigger:
post:
summary: Trigger a slash command for mattermost-slash-commands
description: Added in GitLab 8.13
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project
type: string
required: true
- name: postApiV4ProjectsIdIntegrationsMattermostSlashCommandsTrigger
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdIntegrationsMattermostSlashCommandsTrigger'
responses:
'201':
description: Trigger a slash command for mattermost-slash-commands
'401':
description: Unauthorized
'404':
description: Not found
tags:
- integrations
operationId: postApiV4ProjectsIdIntegrationsMattermostSlashCommandsTrigger
/api/v4/integrations/slack/events:
post:
description: Receive Slack events
produces:
- application/json
consumes:
- application/json
parameters:
- name: postApiV4IntegrationsSlackEvents
in: body
required: true
schema:
$ref: '#/definitions/postApiV4IntegrationsSlackEvents'
responses:
'200':
description: Successfully processed event
'204':
description: Failed to process event
'401':
description: Unauthorized
tags:
- integrations
operationId: postApiV4IntegrationsSlackEvents
/api/v4/integrations/slack/interactions:
post:
summary: Process Slack interaction events
description: Processes interaction events from Slack
produces:
- application/json
consumes:
- application/json
responses:
'201':
description: Process Slack interaction events
tags:
- integrations
operationId: postApiV4IntegrationsSlackInteractions
/api/v4/integrations/slack/options:
post:
summary: Get Slack interactive component options
description: Retrieves options for Slack interactive components
produces:
- application/json
consumes:
- application/json
responses:
'201':
description: Get Slack interactive component options
tags:
- integrations
operationId: postApiV4IntegrationsSlackOptions
/api/v4/slack/trigger:
post:
summary: Trigger a global slack command
description: Added in GitLab 9.4
produces:
- application/json
consumes:
- application/json
parameters:
- name: postApiV4SlackTrigger
in: body
required: true
schema:
$ref: '#/definitions/postApiV4SlackTrigger'
responses:
'201':
description: Trigger a global slack command
'401':
description: Unauthorized
tags:
- integrations
operationId: postApiV4SlackTrigger
definitions:
putApiV4ProjectsIdIntegrationsGithub:
type: object
properties:
token:
type: string
description: GitHub API token with `repo:status` OAuth scope.
repository_url:
type: string
description: GitHub repository URL.
static_context:
type: boolean
description: Append the hostname of your GitLab instance to the status check name.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- repository_url
description: Create/Edit Github integration
API_Entities_IntegrationBasic:
type: object
properties:
id:
type: integer
format: int32
example: 75
title:
type: string
example: Jenkins CI
slug:
type: string
example: jenkins
created_at:
type: string
format: date-time
example: '2019-11-20T11:20:25.297Z'
updated_at:
type: string
format: date-time
example: '2019-11-20T12:24:37.498Z'
active:
type: boolean
commit_events:
type: boolean
push_events:
type: boolean
issues_events:
type: boolean
incident_events:
type: boolean
alert_events:
type: boolean
confidential_issues_events:
type: boolean
merge_requests_events:
type: boolean
tag_push_events:
type: boolean
deployment_events:
type: boolean
note_events:
type: boolean
confidential_note_events:
type: boolean
pipeline_events:
type: boolean
wiki_page_events:
type: boolean
job_events:
type: boolean
comment_on_event_enabled:
type: boolean
inherited:
type: boolean
vulnerability_events:
type: boolean
required:
- id
- title
- slug
- created_at
- updated_at
- active
- commit_events
- push_events
- issues_events
- incident_events
- alert_events
- confidential_issues_events
- merge_requests_events
- tag_push_events
- deployment_events
- note_events
- confidential_note_events
- pipeline_events
- wiki_page_events
- job_events
- comment_on_event_enabled
- inherited
- vulnerability_events
description: API_Entities_IntegrationBasic model
postApiV4IntegrationsSlackEvents:
type: object
properties:
token:
type: string
description: (Deprecated by Slack) The request token, unused by GitLab
team_id:
type: string
description: The Slack workspace ID of where the event occurred
api_app_id:
type: string
description: The Slack app ID
event:
type: object
description: The event object with variable properties
type:
type: string
description: The kind of event this is, usually `event_callback`
event_id:
type: string
description: A unique identifier for this specific event
event_time:
type: integer
format: int32
description: The epoch timestamp in seconds when this event was dispatched
authed_users:
type: array
description: (Deprecated by Slack) An array of Slack user IDs
items:
type: string
description: Receive Slack events
putApiV4GroupsIdIntegrationsGithub:
type: object
properties:
token:
type: string
description: GitHub API token with `repo:status` OAuth scope.
repository_url:
type: string
description: GitHub repository URL.
static_context:
type: boolean
description: Append the hostname of your GitLab instance to the status check name.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- repository_url
description: Create/Edit Github integration
putApiV4ProjectsIdServicesTelegram:
type: object
properties:
hostname:
type: string
description: Custom hostname of the Telegram API. The default value is `https://api.telegram.org`.
token:
type: string
description: The Telegram bot token (for example, `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`).
room:
type: string
description: Unique identifier for the target chat or the username of the target channel (in the format `@channelusername`).
thread:
type: string
description: Unique identifier for the target message thread (topic in a forum supergroup).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- room
description: Create/Edit Telegram integration
putApiV4ProjectsIdServicesMockCi:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
mock_service_url:
type: string
description: URL of the Mock CI integration.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- mock_service_url
description: Create/Edit Mock Ci integration
putApiV4ProjectsIdServicesHangoutsChat:
type: object
properties:
webhook:
type: string
description: The Hangouts Chat webhook (for example, `https://chat.googleapis.com/v1/spaces...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Hangouts Chat integration
putApiV4GroupsIdIntegrationsSlack:
type: object
properties:
webhook:
type: string
description: Slack notifications webhook (for example, `https://hooks.slack.com/services/...`).
username:
type: string
description: Slack notifications username.
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
alert_events:
type: boolean
description: Trigger event when a new, unique alert is recorded.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Slack integration
putApiV4GroupsIdIntegrationsIrker:
type: object
properties:
server_host:
type: string
description: irker daemon hostname. The default value is `localhost`.
server_port:
type: integer
format: int32
description: irker daemon port. The default value is `6659`.
default_irc_uri:
type: string
description: URI to add before each recipient. The default value is `irc://irc.network.net:6697/`.
recipients:
type: string
description: Comma-separated list of channels or email addresses.
colorize_messages:
type: boolean
description: Colorize messages
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Irker integration
putApiV4GroupsIdIntegrationsPumble:
type: object
properties:
webhook:
type: string
description: The Pumble webhook (for example, `https://api.pumble.com/workspaces/x/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Pumble integration
putApiV4ProjectsIdIntegrationsMicrosoftTeams:
type: object
properties:
webhook:
type: string
description: The Microsoft Teams webhook (for example, `https://outlook.office.com/webhook/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Microsoft Teams integration
putApiV4ProjectsIdServicesConfluence:
type: object
properties:
confluence_url:
type: string
description: URL of the Confluence Workspace hosted on `atlassian.net`.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- confluence_url
description: Create/Edit Confluence integration
putApiV4ProjectsIdServicesDroneCi:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
drone_url:
type: string
description: Drone CI URL (for example, `http://drone.example.com`).
token:
type: string
description: Drone CI token.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- drone_url
- token
description: Create/Edit Drone Ci integration
putApiV4GroupsIdIntegrationsConfluence:
type: object
properties:
confluence_url:
type: string
description: URL of the Confluence Workspace hosted on `atlassian.net`.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- confluence_url
description: Create/Edit Confluence integration
putApiV4GroupsIdIntegrationsBamboo:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
bamboo_url:
type: string
description: Bamboo root URL (for example, `https://bamboo.example.com`).
build_key:
type: string
description: Bamboo build plan key (for example, `KEY`).
username:
type: string
description: User with API access to the Bamboo server.
password:
type: string
description: Password of the user.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- bamboo_url
- build_key
- username
- password
description: Create/Edit Bamboo integration
putApiV4ProjectsIdIntegrationsGooglePlay:
type: object
properties:
package_name:
type: string
description: Package name of the app in Google Play.
service_account_key_file_name:
type: string
description: File name of the Google Play service account key.
service_account_key:
type: string
description: Google Play service account key.
google_play_protected_refs:
type: boolean
description: Set variables on protected branches and tags only.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- package_name
- service_account_key_file_name
- service_account_key
description: Create/Edit Google Play integration
putApiV4GroupsIdIntegrationsDroneCi:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
drone_url:
type: string
description: Drone CI URL (for example, `http://drone.example.com`).
token:
type: string
description: Drone CI token.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- drone_url
- token
description: Create/Edit Drone Ci integration
putApiV4GroupsIdIntegrationsMattermost:
type: object
properties:
webhook:
type: string
description: Mattermost notifications webhook (for example, `http://mattermost.example.com/hooks/...`).
username:
type: string
description: Mattermost notifications username.
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Mattermost integration
putApiV4ProjectsIdServicesDatadog:
type: object
properties:
datadog_site:
type: string
description: Datadog site to send data to. Learn more about Datadog sites in the documentation.
api_url:
type: string
description: Full URL of your Datadog site. Only required if you do not use a standard Datadog site.
api_key:
type: string
description: API key used for authentication with Datadog.
datadog_ci_visibility:
type: boolean
description: Enable CI Visibility
archive_trace_events:
type: boolean
description: When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces.
datadog_service:
type: string
description: Tag all pipeline data from this GitLab instance in Datadog. Can be used when managing several self-managed deployments.
datadog_env:
type: string
description: For self-managed deployments, `env` tag for all the data sent to Datadog.
datadog_tags:
type: string
description: Custom tags in Datadog. Specify one tag per line in the format `key:value\nkey2:value2`.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
build_events:
type: boolean
description: Trigger event when a build is created.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
subgroup_events:
type: boolean
project_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
description: Create/Edit Datadog integration
putApiV4ProjectsIdIntegrationsJenkins:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
jenkins_url:
type: string
description: URL of the Jenkins server.
project_name:
type: string
description: Name of the Jenkins project.
username:
type: string
description: Username of the Jenkins server.
password:
type: string
description: Password of the Jenkins server.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- jenkins_url
- project_name
description: Create/Edit Jenkins integration
putApiV4ProjectsIdServicesBuildkite:
type: object
properties:
project_url:
type: string
description: Pipeline URL (for example, `https://buildkite.com/example/pipeline`).
token:
type: string
description: Token you get after you create a Buildkite pipeline with a GitLab repository.
enable_ssl_verification:
type: boolean
description: 'DEPRECATED: This parameter has no effect because SSL verification is always enabled.'
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- token
description: Create/Edit Buildkite integration
putApiV4ProjectsIdServicesPackagist:
type: object
properties:
username:
type: string
description: Username of a Packagist account.
token:
type: string
description: API token of the Packagist server.
server:
type: string
description: URL of the Packagist server. The default value is `https://packagist.org`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- username
- token
description: Create/Edit Packagist integration
putApiV4GroupsIdIntegrationsUnifyCircuit:
type: object
properties:
webhook:
type: string
description: The Unify Circuit webhook (for example, `https://circuit.com/rest/v2/webhooks/incoming/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Unify Circuit integration
putApiV4ProjectsIdIntegrationsCustomIssueTracker:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Custom Issue Tracker integration
putApiV4GroupsIdIntegrationsCampfire:
type: object
properties:
token:
type: string
description: API authentication token from Campfire. To get the token, sign in to Campfire and select **My info**.
subdomain:
type: string
description: '`.campfirenow.com` subdomain when you''re signed in.'
room:
type: string
description: ID portion of the Campfire room URL.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Campfire integration
putApiV4ProjectsIdIntegrationsGitlabSlackApplication:
type: object
properties:
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
alert_events:
type: boolean
description: Trigger event when a new, unique alert is recorded.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Gitlab Slack Application integration
putApiV4ProjectsIdServicesIrker:
type: object
properties:
server_host:
type: string
description: irker daemon hostname. The default value is `localhost`.
server_port:
type: integer
format: int32
description: irker daemon port. The default value is `6659`.
default_irc_uri:
type: string
description: URI to add before each recipient. The default value is `irc://irc.network.net:6697/`.
recipients:
type: string
description: Comma-separated list of channels or email addresses.
colorize_messages:
type: boolean
description: Colorize messages
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Irker integration
putApiV4ProjectsIdServicesAppleAppStore:
type: object
properties:
app_store_issuer_id:
type: string
description: Apple App Store Connect issuer ID.
app_store_key_id:
type: string
description: Apple App Store Connect key ID.
app_store_private_key_file_name:
type: string
description: Apple App Store Connect private key file name.
app_store_private_key:
type: string
description: Apple App Store Connect private key.
app_store_protected_refs:
type: boolean
description: Set variables on protected branches and tags only.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- app_store_issuer_id
- app_store_key_id
- app_store_private_key_file_name
- app_store_private_key
description: Create/Edit Apple App Store integration
putApiV4GroupsIdIntegrationsEwm:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Ewm integration
putApiV4ProjectsIdIntegrationsCampfire:
type: object
properties:
token:
type: string
description: API authentication token from Campfire. To get the token, sign in to Campfire and select **My info**.
subdomain:
type: string
description: '`.campfirenow.com` subdomain when you''re signed in.'
room:
type: string
description: ID portion of the Campfire room URL.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Campfire integration
putApiV4ProjectsIdServicesGoogleCloudPlatformArtifactRegistry:
type: object
properties:
artifact_registry_project_id:
type: string
description: ID of the Google Cloud project.
artifact_registry_repositories:
type: string
description: Repository of Artifact Registry.
artifact_registry_location:
type: string
description: Location of the Artifact Registry repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- artifact_registry_project_id
- artifact_registry_repositories
- artifact_registry_location
description: Create/Edit Google Cloud Platform Artifact Registry integration
putApiV4ProjectsIdIntegrationsYoutrack:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Youtrack integration
putApiV4ProjectsIdServicesCampfire:
type: object
properties:
token:
type: string
description: API authentication token from Campfire. To get the token, sign in to Campfire and select **My info**.
subdomain:
type: string
description: '`.campfirenow.com` subdomain when you''re signed in.'
room:
type: string
description: ID portion of the Campfire room URL.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Campfire integration
putApiV4ProjectsIdServicesCustomIssueTracker:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Custom Issue Tracker integration
putApiV4ProjectsIdIntegrationsAssembla:
type: object
properties:
token:
type: string
description: The authentication token.
subdomain:
type: string
description: The subdomain setting.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Assembla integration
putApiV4ProjectsIdServicesPhorge:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Phorge integration
putApiV4GroupsIdIntegrationsRedmine:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Redmine integration
putApiV4ProjectsIdIntegrationsMockMonitoring:
type: object
properties:
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Mock Monitoring integration
putApiV4ProjectsIdIntegrationsConfluence:
type: object
properties:
confluence_url:
type: string
description: URL of the Confluence Workspace hosted on `atlassian.net`.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- confluence_url
description: Create/Edit Confluence integration
putApiV4GroupsIdIntegrationsPhorge:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Phorge integration
putApiV4ProjectsIdServicesSquashTm:
type: object
properties:
url:
type: string
description: URL of the Squash TM webhook.
token:
type: string
description: Secret token.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
description: Create/Edit Squash Tm integration
putApiV4ProjectsIdServicesGitlabSlackApplication:
type: object
properties:
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
alert_events:
type: boolean
description: Trigger event when a new, unique alert is recorded.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Gitlab Slack Application integration
putApiV4ProjectsIdIntegrationsHangoutsChat:
type: object
properties:
webhook:
type: string
description: The Hangouts Chat webhook (for example, `https://chat.googleapis.com/v1/spaces...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Hangouts Chat integration
putApiV4ProjectsIdIntegrationsZentao:
type: object
properties:
url:
type: string
description: Base URL of the ZenTao instance.
api_url:
type: string
description: If different from Web URL.
api_token:
type: string
zentao_product_xid:
type: string
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- api_token
- zentao_product_xid
description: Create/Edit Zentao integration
putApiV4GroupsIdIntegrationsJenkins:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
jenkins_url:
type: string
description: URL of the Jenkins server.
project_name:
type: string
description: Name of the Jenkins project.
username:
type: string
description: Username of the Jenkins server.
password:
type: string
description: Password of the Jenkins server.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- jenkins_url
- project_name
description: Create/Edit Jenkins integration
putApiV4ProjectsIdServicesPumble:
type: object
properties:
webhook:
type: string
description: The Pumble webhook (for example, `https://api.pumble.com/workspaces/x/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Pumble integration
putApiV4GroupsIdIntegrationsHangoutsChat:
type: object
properties:
webhook:
type: string
description: The Hangouts Chat webhook (for example, `https://chat.googleapis.com/v1/spaces...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Hangouts Chat integration
putApiV4ProjectsIdServicesAssembla:
type: object
properties:
token:
type: string
description: The authentication token.
subdomain:
type: string
description: The subdomain setting.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Assembla integration
putApiV4ProjectsIdIntegrationsPhorge:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Phorge integration
putApiV4ProjectsIdServicesWebexTeams:
type: object
properties:
webhook:
type: string
description: The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/...
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Webex Teams integration
putApiV4ProjectsIdIntegrationsSquashTm:
type: object
properties:
url:
type: string
description: URL of the Squash TM webhook.
token:
type: string
description: Secret token.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
description: Create/Edit Squash Tm integration
putApiV4ProjectsIdServicesSlack:
type: object
properties:
webhook:
type: string
description: Slack notifications webhook (for example, `https://hooks.slack.com/services/...`).
username:
type: string
description: Slack notifications username.
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
alert_events:
type: boolean
description: Trigger event when a new, unique alert is recorded.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Slack integration
putApiV4ProjectsIdServicesLinear:
type: object
properties:
workspace_url:
type: string
description: Linear workspace URL (for example, https://linear.app/example)
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- workspace_url
description: Create/Edit Linear integration
putApiV4ProjectsIdServicesDiffblueCover:
type: object
properties:
diffblue_license_key:
type: string
description: Diffblue Cover license key.
diffblue_access_token_name:
type: string
description: Access token name used by Diffblue Cover in pipelines.
diffblue_access_token_secret:
type: string
description: Access token secret used by Diffblue Cover in pipelines.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- diffblue_license_key
- diffblue_access_token_name
- diffblue_access_token_secret
description: Create/Edit Diffblue Cover integration
putApiV4GroupsIdIntegrationsJiraCloudApp:
type: object
properties:
jira_cloud_app_service_ids:
type: string
description: Copy and paste your JSM Service ID here. Use comma (,) to separate multiple IDs.
jira_cloud_app_enable_deployment_gating:
type: boolean
description: Enable to approve or reject blocked GitLab deployments from Jira Service Management.
jira_cloud_app_deployment_gating_environments:
type: string
description: Enter the environment (production,staging,testing,development) where you want to enable deployment gating. Use comma (,) to separate multiple environments.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Jira Cloud App integration
putApiV4GroupsIdIntegrationsDiffblueCover:
type: object
properties:
diffblue_license_key:
type: string
description: Diffblue Cover license key.
diffblue_access_token_name:
type: string
description: Access token name used by Diffblue Cover in pipelines.
diffblue_access_token_secret:
type: string
description: Access token secret used by Diffblue Cover in pipelines.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- diffblue_license_key
- diffblue_access_token_name
- diffblue_access_token_secret
description: Create/Edit Diffblue Cover integration
putApiV4GroupsIdIntegrationsGooglePlay:
type: object
properties:
package_name:
type: string
description: Package name of the app in Google Play.
service_account_key_file_name:
type: string
description: File name of the Google Play service account key.
service_account_key:
type: string
description: Google Play service account key.
google_play_protected_refs:
type: boolean
description: Set variables on protected branches and tags only.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- package_name
- service_account_key_file_name
- service_account_key
description: Create/Edit Google Play integration
API_Entities_Integration:
type: object
properties:
id:
type: integer
format: int32
example: 75
title:
type: string
example: Jenkins CI
slug:
type: string
example: jenkins
created_at:
type: string
format: date-time
example: '2019-11-20T11:20:25.297Z'
updated_at:
type: string
format: date-time
example: '2019-11-20T12:24:37.498Z'
active:
type: boolean
commit_events:
type: boolean
push_events:
type: boolean
issues_events:
type: boolean
incident_events:
type: boolean
alert_events:
type: boolean
confidential_issues_events:
type: boolean
merge_requests_events:
type: boolean
tag_push_events:
type: boolean
deployment_events:
type: boolean
note_events:
type: boolean
confidential_note_events:
type: boolean
pipeline_events:
type: boolean
wiki_page_events:
type: boolean
job_events:
type: boolean
comment_on_event_enabled:
type: boolean
inherited:
type: boolean
vulnerability_events:
type: boolean
properties:
type: object
example:
token: secr3t
required:
- id
- title
- slug
- created_at
- updated_at
- active
- commit_events
- push_events
- issues_events
- incident_events
- alert_events
- confidential_issues_events
- merge_requests_events
- tag_push_events
- deployment_events
- note_events
- confidential_note_events
- pipeline_events
- wiki_page_events
- job_events
- comment_on_event_enabled
- inherited
- vulnerability_events
- properties
description: API_Entities_Integration model
putApiV4ProjectsIdServicesGithub:
type: object
properties:
token:
type: string
description: GitHub API token with `repo:status` OAuth scope.
repository_url:
type: string
description: GitHub repository URL.
static_context:
type: boolean
description: Append the hostname of your GitLab instance to the status check name.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- repository_url
description: Create/Edit Github integration
putApiV4GroupsIdIntegrationsPackagist:
type: object
properties:
username:
type: string
description: Username of a Packagist account.
token:
type: string
description: API token of the Packagist server.
server:
type: string
description: URL of the Packagist server. The default value is `https://packagist.org`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- username
- token
description: Create/Edit Packagist integration
putApiV4ProjectsIdServicesEwm:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Ewm integration
putApiV4GroupsIdIntegrationsYoutrack:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Youtrack integration
putApiV4GroupsIdIntegrationsMockMonitoring:
type: object
properties:
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Mock Monitoring integration
putApiV4ProjectsIdServicesAsana:
type: object
properties:
api_key:
type: string
description: User API token. The user must have access to the task. All comments are attributed to this user.
restrict_to_branch:
type: string
description: Comma-separated list of branches to be automatically inspected. Leave blank to include all branches.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
description: Create/Edit Asana integration
putApiV4ProjectsIdServicesRedmine:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Redmine integration
putApiV4ProjectsIdIntegrationsGitGuardian:
type: object
properties:
token:
type: string
description: Personal access token to authenticate calls to the GitGuardian API.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Git Guardian integration
putApiV4ProjectsIdServicesHarbor:
type: object
properties:
url:
type: string
description: The base URL to the Harbor instance linked to the GitLab project. For example, `https://demo.goharbor.io`.
project_name:
type: string
description: The name of the project in the Harbor instance. For example, `testproject`.
username:
type: string
description: The username created in the Harbor interface.
password:
type: string
description: The password of the user.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- project_name
- username
- password
description: Create/Edit Harbor integration
putApiV4ProjectsIdServicesMattermostSlashCommands:
type: object
properties:
token:
type: string
description: The Mattermost token.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Mattermost Slash Commands integration
putApiV4ProjectsIdServicesEmailsOnPush:
type: object
properties:
send_from_committer_email:
type: boolean
description: Send from committer
disable_diffs:
type: boolean
description: Disable code diffs
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
recipients:
type: string
description: Emails separated by whitespace.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Emails On Push integration
putApiV4ProjectsIdServicesBamboo:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
bamboo_url:
type: string
description: Bamboo root URL (for example, `https://bamboo.example.com`).
build_key:
type: string
description: Bamboo build plan key (for example, `KEY`).
username:
type: string
description: User with API access to the Bamboo server.
password:
type: string
description: Password of the user.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- bamboo_url
- build_key
- username
- password
description: Create/Edit Bamboo integration
putApiV4GroupsIdIntegrationsGitlabSlackApplication:
type: object
properties:
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
alert_events:
type: boolean
description: Trigger event when a new, unique alert is recorded.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Gitlab Slack Application integration
putApiV4GroupsIdIntegrationsExternalWiki:
type: object
properties:
external_wiki_url:
type: string
description: URL of the external wiki.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- external_wiki_url
description: Create/Edit External Wiki integration
putApiV4GroupsIdIntegrationsLinear:
type: object
properties:
workspace_url:
type: string
description: Linear workspace URL (for example, https://linear.app/example)
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- workspace_url
description: Create/Edit Linear integration
postApiV4ProjectsIdIntegrationsMattermostSlashCommandsTrigger:
type: object
properties:
token:
type: string
description: The Mattermost token.
required:
- token
description: Trigger a slash command for mattermost-slash-commands
putApiV4ProjectsIdIntegrationsWebexTeams:
type: object
properties:
webhook:
type: string
description: The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/...
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Webex Teams integration
putApiV4ProjectsIdServicesMockMonitoring:
type: object
properties:
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Mock Monitoring integration
putApiV4GroupsIdIntegrationsGitGuardian:
type: object
properties:
token:
type: string
description: Personal access token to authenticate calls to the GitGuardian API.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Git Guardian integration
putApiV4ProjectsIdIntegrationsClickup:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Clickup integration
postApiV4ProjectsIdServicesMattermostSlashCommandsTrigger:
type: object
properties:
token:
type: string
description: The Mattermost token.
required:
- token
description: Trigger a slash command for mattermost-slash-commands
putApiV4GroupsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation:
type: object
properties:
workload_identity_federation_project_id:
type: string
description: Google Cloud project ID for the Workload Identity Federation.
workload_identity_federation_project_number:
type: string
description: Google Cloud project number for the Workload Identity Federation.
workload_identity_pool_id:
type: string
description: ID of the Workload Identity Pool.
workload_identity_pool_provider_id:
type: string
description: ID of the Workload Identity Pool provider.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- workload_identity_federation_project_id
- workload_identity_federation_project_number
- workload_identity_pool_id
- workload_identity_pool_provider_id
description: Create/Edit Google Cloud Platform Workload Identity Federation integration
putApiV4GroupsIdIntegrationsHarbor:
type: object
properties:
url:
type: string
description: The base URL to the Harbor instance linked to the GitLab project. For example, `https://demo.goharbor.io`.
project_name:
type: string
description: The name of the project in the Harbor instance. For example, `testproject`.
username:
type: string
description: The username created in the Harbor interface.
password:
type: string
description: The password of the user.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- project_name
- username
- password
description: Create/Edit Harbor integration
putApiV4GroupsIdIntegrationsEmailsOnPush:
type: object
properties:
send_from_committer_email:
type: boolean
description: Send from committer
disable_diffs:
type: boolean
description: Disable code diffs
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
recipients:
type: string
description: Emails separated by whitespace.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Emails On Push integration
putApiV4ProjectsIdServicesGooglePlay:
type: object
properties:
package_name:
type: string
description: Package name of the app in Google Play.
service_account_key_file_name:
type: string
description: File name of the Google Play service account key.
service_account_key:
type: string
description: Google Play service account key.
google_play_protected_refs:
type: boolean
description: Set variables on protected branches and tags only.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- package_name
- service_account_key_file_name
- service_account_key
description: Create/Edit Google Play integration
putApiV4GroupsIdIntegrationsAppleAppStore:
type: object
properties:
app_store_issuer_id:
type: string
description: Apple App Store Connect issuer ID.
app_store_key_id:
type: string
description: Apple App Store Connect key ID.
app_store_private_key_file_name:
type: string
description: Apple App Store Connect private key file name.
app_store_private_key:
type: string
description: Apple App Store Connect private key.
app_store_protected_refs:
type: boolean
description: Set variables on protected branches and tags only.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- app_store_issuer_id
- app_store_key_id
- app_store_private_key_file_name
- app_store_private_key
description: Create/Edit Apple App Store integration
putApiV4GroupsIdIntegrationsBuildkite:
type: object
properties:
project_url:
type: string
description: Pipeline URL (for example, `https://buildkite.com/example/pipeline`).
token:
type: string
description: Token you get after you create a Buildkite pipeline with a GitLab repository.
enable_ssl_verification:
type: boolean
description: 'DEPRECATED: This parameter has no effect because SSL verification is always enabled.'
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- token
description: Create/Edit Buildkite integration
putApiV4ProjectsIdIntegrationsHarbor:
type: object
properties:
url:
type: string
description: The base URL to the Harbor instance linked to the GitLab project. For example, `https://demo.goharbor.io`.
project_name:
type: string
description: The name of the project in the Harbor instance. For example, `testproject`.
username:
type: string
description: The username created in the Harbor interface.
password:
type: string
description: The password of the user.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- project_name
- username
- password
description: Create/Edit Harbor integration
putApiV4GroupsIdIntegrationsWebexTeams:
type: object
properties:
webhook:
type: string
description: The Webex Teams webhook. For example, https://api.ciscospark.com/v1/webhooks/incoming/...
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Webex Teams integration
putApiV4ProjectsIdServicesExternalWiki:
type: object
properties:
external_wiki_url:
type: string
description: URL of the external wiki.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- external_wiki_url
description: Create/Edit External Wiki integration
postApiV4SlackTrigger:
type: object
properties:
text:
type: string
description: Text of the slack command
required:
- text
description: Trigger a global slack command
putApiV4ProjectsIdIntegrationsJira:
type: object
properties:
url:
type: string
description: The URL to the Jira project which is being linked to this GitLab project (for example, `https://jira.example.com`).
api_url:
type: string
description: The base URL to the Jira instance API. Web URL value is used if not set (for example, `https://jira-api.example.com`).
jira_auth_type:
type: integer
format: int32
description: The authentication method to use with Jira. Use `0` for basic authentication, `1` for Jira personal access token, and `2` for Jira Cloud service accounts. Defaults to `0`.
username:
type: string
description: The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (`jira_auth_type` is `0`).
password:
type: string
description: The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (`jira_auth_type` is `0`), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (`jira_auth_type` is `1`), use the personal access token.
jira_issue_regex:
type: string
description: Regular expression to match Jira issue keys.
jira_issue_prefix:
type: string
description: Prefix to match Jira issue keys.
jira_issue_transition_id:
type: string
description: The ID of one or more transitions for [custom issue transitions](../integration/jira/issues.md#custom-issue-transitions).Ignored when `jira_issue_transition_automatic` is enabled. Defaults to a blank string,which disables custom transitions.
issues_enabled:
type: string
description: Enable viewing Jira issues in GitLab.
project_keys:
type: array
description: Keys of Jira projects. When `issues_enabled` is `true`, this setting specifies which Jira projects to view issues from in GitLab.
items:
type: string
vulnerabilities_enabled:
type: boolean
description: Turn on Jira issue creation for GitLab vulnerabilities.
vulnerabilities_issuetype:
type: string
description: Jira issue type to use when creating issues from vulnerabilities.
project_key:
type: string
description: Key of the project to use when creating issues from vulnerabilities.This parameter is required if using the integration to create Jira issues from vulnerabilities.
customize_jira_issue_enabled:
type: boolean
description: When set to `true`, opens a prefilled form on the Jira instancewhen creating a Jira issue from a vulnerability.
jira_check_enabled:
type: boolean
description: Verify Jira issues referenced in commit messages exist before allowing the push.
jira_exists_check_enabled:
type: boolean
description: Verify the Jira issues referenced in commit messages exist in Jira.
jira_assignee_check_enabled:
type: boolean
description: Verify the committer is the assignee of the Jira issues referenced in commit messages.
jira_status_check_enabled:
type: boolean
description: Verify the status of Jira issues referenced in commit messages.
jira_allowed_statuses_as_string:
type: string
description: Comma-separated list of allowed Jira issue statuses.
comment_on_event_enabled:
type: boolean
description: Enable comments inside Jira issues on each GitLab event (commit / merge request)
commit_events:
type: boolean
description: Trigger event when a commit is created or updated.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- password
description: Create/Edit Jira integration
putApiV4GroupsIdIntegrationsPushover:
type: object
properties:
api_key:
type: string
description: The application key.
user_key:
type: string
description: The user key.
device:
type: string
description: Leave blank for all active devices.
priority:
type: string
description: The priority.
sound:
type: string
description: The sound of the notification.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
- user_key
- priority
description: Create/Edit Pushover integration
putApiV4ProjectsIdIntegrationsAppleAppStore:
type: object
properties:
app_store_issuer_id:
type: string
description: Apple App Store Connect issuer ID.
app_store_key_id:
type: string
description: Apple App Store Connect key ID.
app_store_private_key_file_name:
type: string
description: Apple App Store Connect private key file name.
app_store_private_key:
type: string
description: Apple App Store Connect private key.
app_store_protected_refs:
type: boolean
description: Set variables on protected branches and tags only.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- app_store_issuer_id
- app_store_key_id
- app_store_private_key_file_name
- app_store_private_key
description: Create/Edit Apple App Store integration
putApiV4ProjectsIdServicesMattermost:
type: object
properties:
webhook:
type: string
description: Mattermost notifications webhook (for example, `http://mattermost.example.com/hooks/...`).
username:
type: string
description: Mattermost notifications username.
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Mattermost integration
putApiV4GroupsIdIntegrationsTeamcity:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
teamcity_url:
type: string
description: TeamCity root URL (for example, `https://teamcity.example.com`).
build_type:
type: string
description: The build configuration ID of the TeamCity project.
username:
type: string
description: A user with permissions to trigger a manual build.
password:
type: string
description: The password of the user.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- teamcity_url
- build_type
- username
- password
description: Create/Edit Teamcity integration
putApiV4ProjectsIdIntegrationsMattermost:
type: object
properties:
webhook:
type: string
description: Mattermost notifications webhook (for example, `http://mattermost.example.com/hooks/...`).
username:
type: string
description: Mattermost notifications username.
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Mattermost integration
putApiV4ProjectsIdIntegrationsPushover:
type: object
properties:
api_key:
type: string
description: The application key.
user_key:
type: string
description: The user key.
device:
type: string
description: Leave blank for all active devices.
priority:
type: string
description: The priority.
sound:
type: string
description: The sound of the notification.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
- user_key
- priority
description: Create/Edit Pushover integration
putApiV4ProjectsIdIntegrationsRedmine:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Redmine integration
putApiV4ProjectsIdServicesClickup:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Clickup integration
putApiV4ProjectsIdIntegrationsTelegram:
type: object
properties:
hostname:
type: string
description: Custom hostname of the Telegram API. The default value is `https://api.telegram.org`.
token:
type: string
description: The Telegram bot token (for example, `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`).
room:
type: string
description: Unique identifier for the target chat or the username of the target channel (in the format `@channelusername`).
thread:
type: string
description: Unique identifier for the target message thread (topic in a forum supergroup).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- room
description: Create/Edit Telegram integration
putApiV4ProjectsIdIntegrationsPumble:
type: object
properties:
webhook:
type: string
description: The Pumble webhook (for example, `https://api.pumble.com/workspaces/x/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Pumble integration
putApiV4ProjectsIdIntegrationsAsana:
type: object
properties:
api_key:
type: string
description: User API token. The user must have access to the task. All comments are attributed to this user.
restrict_to_branch:
type: string
description: Comma-separated list of branches to be automatically inspected. Leave blank to include all branches.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
description: Create/Edit Asana integration
putApiV4ProjectsIdIntegrationsPackagist:
type: object
properties:
username:
type: string
description: Username of a Packagist account.
token:
type: string
description: API token of the Packagist server.
server:
type: string
description: URL of the Packagist server. The default value is `https://packagist.org`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- username
- token
description: Create/Edit Packagist integration
putApiV4ProjectsIdIntegrationsPivotaltracker:
type: object
properties:
token:
type: string
description: The Pivotal Tracker token.
restrict_to_branch:
type: string
description: Comma-separated list of branches to automatically inspect. Leave blank to include all branches.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Pivotaltracker integration
putApiV4ProjectsIdIntegrationsBamboo:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
bamboo_url:
type: string
description: Bamboo root URL (for example, `https://bamboo.example.com`).
build_key:
type: string
description: Bamboo build plan key (for example, `KEY`).
username:
type: string
description: User with API access to the Bamboo server.
password:
type: string
description: Password of the user.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- bamboo_url
- build_key
- username
- password
description: Create/Edit Bamboo integration
putApiV4ProjectsIdIntegrationsJiraCloudApp:
type: object
properties:
jira_cloud_app_service_ids:
type: string
description: Copy and paste your JSM Service ID here. Use comma (,) to separate multiple IDs.
jira_cloud_app_enable_deployment_gating:
type: boolean
description: Enable to approve or reject blocked GitLab deployments from Jira Service Management.
jira_cloud_app_deployment_gating_environments:
type: string
description: Enter the environment (production,staging,testing,development) where you want to enable deployment gating. Use comma (,) to separate multiple environments.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Jira Cloud App integration
putApiV4ProjectsIdServicesZentao:
type: object
properties:
url:
type: string
description: Base URL of the ZenTao instance.
api_url:
type: string
description: If different from Web URL.
api_token:
type: string
zentao_product_xid:
type: string
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- api_token
- zentao_product_xid
description: Create/Edit Zentao integration
putApiV4ProjectsIdIntegrationsDiffblueCover:
type: object
properties:
diffblue_license_key:
type: string
description: Diffblue Cover license key.
diffblue_access_token_name:
type: string
description: Access token name used by Diffblue Cover in pipelines.
diffblue_access_token_secret:
type: string
description: Access token secret used by Diffblue Cover in pipelines.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- diffblue_license_key
- diffblue_access_token_name
- diffblue_access_token_secret
description: Create/Edit Diffblue Cover integration
putApiV4ProjectsIdIntegrationsEmailsOnPush:
type: object
properties:
send_from_committer_email:
type: boolean
description: Send from committer
disable_diffs:
type: boolean
description: Disable code diffs
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
recipients:
type: string
description: Emails separated by whitespace.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Emails On Push integration
putApiV4ProjectsIdServicesBugzilla:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Bugzilla integration
putApiV4GroupsIdIntegrationsBugzilla:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Bugzilla integration
putApiV4ProjectsIdIntegrationsPipelinesEmail:
type: object
properties:
recipients:
type: string
description: Comma-separated list of recipient email addresses.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
notify_only_default_branch:
type: boolean
description: Send notifications for the default branch.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
notify_child_pipelines:
type: boolean
description: Send notifications for child pipelines.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Pipelines Email integration
putApiV4ProjectsIdServicesMicrosoftTeams:
type: object
properties:
webhook:
type: string
description: The Microsoft Teams webhook (for example, `https://outlook.office.com/webhook/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Microsoft Teams integration
putApiV4ProjectsIdServicesPipelinesEmail:
type: object
properties:
recipients:
type: string
description: Comma-separated list of recipient email addresses.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
notify_only_default_branch:
type: boolean
description: Send notifications for the default branch.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
notify_child_pipelines:
type: boolean
description: Send notifications for child pipelines.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Pipelines Email integration
putApiV4ProjectsIdIntegrationsMatrix:
type: object
properties:
hostname:
type: string
description: Custom hostname of the Matrix server. The default value is `https://matrix-client.matrix.org`.
token:
type: string
description: The Matrix access token (for example, `syt-zyx57W2v1u123ew11`).
room:
type: string
description: Unique identifier for the target room (in the format `!qPKKM111FFKKsfoCVy:matrix.org`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- room
description: Create/Edit Matrix integration
putApiV4ProjectsIdServicesYoutrack:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Youtrack integration
putApiV4GroupsIdIntegrationsMockCi:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
mock_service_url:
type: string
description: URL of the Mock CI integration.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- mock_service_url
description: Create/Edit Mock Ci integration
putApiV4ProjectsIdIntegrationsSlack:
type: object
properties:
webhook:
type: string
description: Slack notifications webhook (for example, `https://hooks.slack.com/services/...`).
username:
type: string
description: Slack notifications username.
channel:
type: string
description: Default channel to use if no other channel is configured.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
labels_to_be_notified:
type: string
description: Labels to send notifications for. Leave blank to receive notifications for all events.
labels_to_be_notified_behavior:
type: string
description: Labels to be notified for. Valid options are `match_any` and `match_all`. The default value is `match_any`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
alert_events:
type: boolean
description: Trigger event when a new, unique alert is recorded.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Slack integration
putApiV4GroupsIdIntegrationsPivotaltracker:
type: object
properties:
token:
type: string
description: The Pivotal Tracker token.
restrict_to_branch:
type: string
description: Comma-separated list of branches to automatically inspect. Leave blank to include all branches.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Pivotaltracker integration
putApiV4GroupsIdIntegrationsDatadog:
type: object
properties:
datadog_site:
type: string
description: Datadog site to send data to. Learn more about Datadog sites in the documentation.
api_url:
type: string
description: Full URL of your Datadog site. Only required if you do not use a standard Datadog site.
api_key:
type: string
description: API key used for authentication with Datadog.
datadog_ci_visibility:
type: boolean
description: Enable CI Visibility
archive_trace_events:
type: boolean
description: When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces.
datadog_service:
type: string
description: Tag all pipeline data from this GitLab instance in Datadog. Can be used when managing several self-managed deployments.
datadog_env:
type: string
description: For self-managed deployments, `env` tag for all the data sent to Datadog.
datadog_tags:
type: string
description: Custom tags in Datadog. Specify one tag per line in the format `key:value\nkey2:value2`.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
build_events:
type: boolean
description: Trigger event when a build is created.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
subgroup_events:
type: boolean
project_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
description: Create/Edit Datadog integration
putApiV4ProjectsIdIntegrationsBuildkite:
type: object
properties:
project_url:
type: string
description: Pipeline URL (for example, `https://buildkite.com/example/pipeline`).
token:
type: string
description: Token you get after you create a Buildkite pipeline with a GitLab repository.
enable_ssl_verification:
type: boolean
description: 'DEPRECATED: This parameter has no effect because SSL verification is always enabled.'
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- token
description: Create/Edit Buildkite integration
putApiV4GroupsIdIntegrationsMicrosoftTeams:
type: object
properties:
webhook:
type: string
description: The Microsoft Teams webhook (for example, `https://outlook.office.com/webhook/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Microsoft Teams integration
putApiV4ProjectsIdIntegrationsUnifyCircuit:
type: object
properties:
webhook:
type: string
description: The Unify Circuit webhook (for example, `https://circuit.com/rest/v2/webhooks/incoming/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Unify Circuit integration
putApiV4GroupsIdIntegrationsGoogleCloudPlatformArtifactRegistry:
type: object
properties:
artifact_registry_project_id:
type: string
description: ID of the Google Cloud project.
artifact_registry_repositories:
type: string
description: Repository of Artifact Registry.
artifact_registry_location:
type: string
description: Location of the Artifact Registry repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- artifact_registry_project_id
- artifact_registry_repositories
- artifact_registry_location
description: Create/Edit Google Cloud Platform Artifact Registry integration
putApiV4ProjectsIdIntegrationsDroneCi:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
drone_url:
type: string
description: Drone CI URL (for example, `http://drone.example.com`).
token:
type: string
description: Drone CI token.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- drone_url
- token
description: Create/Edit Drone Ci integration
putApiV4ProjectsIdIntegrationsExternalWiki:
type: object
properties:
external_wiki_url:
type: string
description: URL of the external wiki.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- external_wiki_url
description: Create/Edit External Wiki integration
putApiV4GroupsIdIntegrationsMatrix:
type: object
properties:
hostname:
type: string
description: Custom hostname of the Matrix server. The default value is `https://matrix-client.matrix.org`.
token:
type: string
description: The Matrix access token (for example, `syt-zyx57W2v1u123ew11`).
room:
type: string
description: Unique identifier for the target room (in the format `!qPKKM111FFKKsfoCVy:matrix.org`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- room
description: Create/Edit Matrix integration
putApiV4ProjectsIdIntegrationsLinear:
type: object
properties:
workspace_url:
type: string
description: Linear workspace URL (for example, https://linear.app/example)
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- workspace_url
description: Create/Edit Linear integration
putApiV4ProjectsIdIntegrationsIrker:
type: object
properties:
server_host:
type: string
description: irker daemon hostname. The default value is `localhost`.
server_port:
type: integer
format: int32
description: irker daemon port. The default value is `6659`.
default_irc_uri:
type: string
description: URI to add before each recipient. The default value is `irc://irc.network.net:6697/`.
recipients:
type: string
description: Comma-separated list of channels or email addresses.
colorize_messages:
type: boolean
description: Colorize messages
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Irker integration
putApiV4GroupsIdIntegrationsSquashTm:
type: object
properties:
url:
type: string
description: URL of the Squash TM webhook.
token:
type: string
description: Secret token.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
description: Create/Edit Squash Tm integration
putApiV4GroupsIdIntegrationsPipelinesEmail:
type: object
properties:
recipients:
type: string
description: Comma-separated list of recipient email addresses.
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
notify_only_default_branch:
type: boolean
description: Send notifications for the default branch.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
notify_child_pipelines:
type: boolean
description: Send notifications for child pipelines.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- recipients
description: Create/Edit Pipelines Email integration
putApiV4ProjectsIdIntegrationsDatadog:
type: object
properties:
datadog_site:
type: string
description: Datadog site to send data to. Learn more about Datadog sites in the documentation.
api_url:
type: string
description: Full URL of your Datadog site. Only required if you do not use a standard Datadog site.
api_key:
type: string
description: API key used for authentication with Datadog.
datadog_ci_visibility:
type: boolean
description: Enable CI Visibility
archive_trace_events:
type: boolean
description: When enabled, job logs are collected by Datadog and displayed along with pipeline execution traces.
datadog_service:
type: string
description: Tag all pipeline data from this GitLab instance in Datadog. Can be used when managing several self-managed deployments.
datadog_env:
type: string
description: For self-managed deployments, `env` tag for all the data sent to Datadog.
datadog_tags:
type: string
description: Custom tags in Datadog. Specify one tag per line in the format `key:value\nkey2:value2`.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
build_events:
type: boolean
description: Trigger event when a build is created.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
subgroup_events:
type: boolean
project_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
description: Create/Edit Datadog integration
putApiV4ProjectsIdServicesPivotaltracker:
type: object
properties:
token:
type: string
description: The Pivotal Tracker token.
restrict_to_branch:
type: string
description: Comma-separated list of branches to automatically inspect. Leave blank to include all branches.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Pivotaltracker integration
putApiV4ProjectsIdIntegrationsEwm:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Ewm integration
putApiV4GroupsIdIntegrationsClickup:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
description: Create/Edit Clickup integration
putApiV4ProjectsIdIntegrationsMockCi:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
mock_service_url:
type: string
description: URL of the Mock CI integration.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- mock_service_url
description: Create/Edit Mock Ci integration
putApiV4GroupsIdIntegrationsAssembla:
type: object
properties:
token:
type: string
description: The authentication token.
subdomain:
type: string
description: The subdomain setting.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Assembla integration
putApiV4ProjectsIdIntegrationsGoogleCloudPlatformArtifactRegistry:
type: object
properties:
artifact_registry_project_id:
type: string
description: ID of the Google Cloud project.
artifact_registry_repositories:
type: string
description: Repository of Artifact Registry.
artifact_registry_location:
type: string
description: Location of the Artifact Registry repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- artifact_registry_project_id
- artifact_registry_repositories
- artifact_registry_location
description: Create/Edit Google Cloud Platform Artifact Registry integration
putApiV4ProjectsIdServicesDiscord:
type: object
properties:
webhook:
type: string
description: Discord webhook (for example, `https://discord.com/api/webhooks/…`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Discord integration
putApiV4ProjectsIdIntegrationsMattermostSlashCommands:
type: object
properties:
token:
type: string
description: The Mattermost token.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Mattermost Slash Commands integration
putApiV4GroupsIdIntegrationsJira:
type: object
properties:
url:
type: string
description: The URL to the Jira project which is being linked to this GitLab project (for example, `https://jira.example.com`).
api_url:
type: string
description: The base URL to the Jira instance API. Web URL value is used if not set (for example, `https://jira-api.example.com`).
jira_auth_type:
type: integer
format: int32
description: The authentication method to use with Jira. Use `0` for basic authentication, `1` for Jira personal access token, and `2` for Jira Cloud service accounts. Defaults to `0`.
username:
type: string
description: The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (`jira_auth_type` is `0`).
password:
type: string
description: The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (`jira_auth_type` is `0`), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (`jira_auth_type` is `1`), use the personal access token.
jira_issue_regex:
type: string
description: Regular expression to match Jira issue keys.
jira_issue_prefix:
type: string
description: Prefix to match Jira issue keys.
jira_issue_transition_id:
type: string
description: The ID of one or more transitions for [custom issue transitions](../integration/jira/issues.md#custom-issue-transitions).Ignored when `jira_issue_transition_automatic` is enabled. Defaults to a blank string,which disables custom transitions.
issues_enabled:
type: string
description: Enable viewing Jira issues in GitLab.
project_keys:
type: array
description: Keys of Jira projects. When `issues_enabled` is `true`, this setting specifies which Jira projects to view issues from in GitLab.
items:
type: string
vulnerabilities_enabled:
type: boolean
description: Turn on Jira issue creation for GitLab vulnerabilities.
vulnerabilities_issuetype:
type: string
description: Jira issue type to use when creating issues from vulnerabilities.
project_key:
type: string
description: Key of the project to use when creating issues from vulnerabilities.This parameter is required if using the integration to create Jira issues from vulnerabilities.
customize_jira_issue_enabled:
type: boolean
description: When set to `true`, opens a prefilled form on the Jira instancewhen creating a Jira issue from a vulnerability.
jira_check_enabled:
type: boolean
description: Verify Jira issues referenced in commit messages exist before allowing the push.
jira_exists_check_enabled:
type: boolean
description: Verify the Jira issues referenced in commit messages exist in Jira.
jira_assignee_check_enabled:
type: boolean
description: Verify the committer is the assignee of the Jira issues referenced in commit messages.
jira_status_check_enabled:
type: boolean
description: Verify the status of Jira issues referenced in commit messages.
jira_allowed_statuses_as_string:
type: string
description: Comma-separated list of allowed Jira issue statuses.
comment_on_event_enabled:
type: boolean
description: Enable comments inside Jira issues on each GitLab event (commit / merge request)
commit_events:
type: boolean
description: Trigger event when a commit is created or updated.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- password
description: Create/Edit Jira integration
putApiV4ProjectsIdServicesJira:
type: object
properties:
url:
type: string
description: The URL to the Jira project which is being linked to this GitLab project (for example, `https://jira.example.com`).
api_url:
type: string
description: The base URL to the Jira instance API. Web URL value is used if not set (for example, `https://jira-api.example.com`).
jira_auth_type:
type: integer
format: int32
description: The authentication method to use with Jira. Use `0` for basic authentication, `1` for Jira personal access token, and `2` for Jira Cloud service accounts. Defaults to `0`.
username:
type: string
description: The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (`jira_auth_type` is `0`).
password:
type: string
description: The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (`jira_auth_type` is `0`), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (`jira_auth_type` is `1`), use the personal access token.
jira_issue_regex:
type: string
description: Regular expression to match Jira issue keys.
jira_issue_prefix:
type: string
description: Prefix to match Jira issue keys.
jira_issue_transition_id:
type: string
description: The ID of one or more transitions for [custom issue transitions](../integration/jira/issues.md#custom-issue-transitions).Ignored when `jira_issue_transition_automatic` is enabled. Defaults to a blank string,which disables custom transitions.
issues_enabled:
type: string
description: Enable viewing Jira issues in GitLab.
project_keys:
type: array
description: Keys of Jira projects. When `issues_enabled` is `true`, this setting specifies which Jira projects to view issues from in GitLab.
items:
type: string
vulnerabilities_enabled:
type: boolean
description: Turn on Jira issue creation for GitLab vulnerabilities.
vulnerabilities_issuetype:
type: string
description: Jira issue type to use when creating issues from vulnerabilities.
project_key:
type: string
description: Key of the project to use when creating issues from vulnerabilities.This parameter is required if using the integration to create Jira issues from vulnerabilities.
customize_jira_issue_enabled:
type: boolean
description: When set to `true`, opens a prefilled form on the Jira instancewhen creating a Jira issue from a vulnerability.
jira_check_enabled:
type: boolean
description: Verify Jira issues referenced in commit messages exist before allowing the push.
jira_exists_check_enabled:
type: boolean
description: Verify the Jira issues referenced in commit messages exist in Jira.
jira_assignee_check_enabled:
type: boolean
description: Verify the committer is the assignee of the Jira issues referenced in commit messages.
jira_status_check_enabled:
type: boolean
description: Verify the status of Jira issues referenced in commit messages.
jira_allowed_statuses_as_string:
type: string
description: Comma-separated list of allowed Jira issue statuses.
comment_on_event_enabled:
type: boolean
description: Enable comments inside Jira issues on each GitLab event (commit / merge request)
commit_events:
type: boolean
description: Trigger event when a commit is created or updated.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- password
description: Create/Edit Jira integration
putApiV4ProjectsIdIntegrationsTeamcity:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
teamcity_url:
type: string
description: TeamCity root URL (for example, `https://teamcity.example.com`).
build_type:
type: string
description: The build configuration ID of the TeamCity project.
username:
type: string
description: A user with permissions to trigger a manual build.
password:
type: string
description: The password of the user.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- teamcity_url
- build_type
- username
- password
description: Create/Edit Teamcity integration
putApiV4GroupsIdIntegrationsMattermostSlashCommands:
type: object
properties:
token:
type: string
description: The Mattermost token.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Mattermost Slash Commands integration
putApiV4GroupsIdIntegrationsAsana:
type: object
properties:
api_key:
type: string
description: User API token. The user must have access to the task. All comments are attributed to this user.
restrict_to_branch:
type: string
description: Comma-separated list of branches to be automatically inspected. Leave blank to include all branches.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
description: Create/Edit Asana integration
putApiV4GroupsIdIntegrationsDiscord:
type: object
properties:
webhook:
type: string
description: Discord webhook (for example, `https://discord.com/api/webhooks/…`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Discord integration
putApiV4ProjectsIdServicesJiraCloudApp:
type: object
properties:
jira_cloud_app_service_ids:
type: string
description: Copy and paste your JSM Service ID here. Use comma (,) to separate multiple IDs.
jira_cloud_app_enable_deployment_gating:
type: boolean
description: Enable to approve or reject blocked GitLab deployments from Jira Service Management.
jira_cloud_app_deployment_gating_environments:
type: string
description: Enter the environment (production,staging,testing,development) where you want to enable deployment gating. Use comma (,) to separate multiple environments.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
description: Create/Edit Jira Cloud App integration
putApiV4ProjectsIdIntegrationsBugzilla:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Bugzilla integration
putApiV4ProjectsIdServicesTeamcity:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
teamcity_url:
type: string
description: TeamCity root URL (for example, `https://teamcity.example.com`).
build_type:
type: string
description: The build configuration ID of the TeamCity project.
username:
type: string
description: A user with permissions to trigger a manual build.
password:
type: string
description: The password of the user.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- teamcity_url
- build_type
- username
- password
description: Create/Edit Teamcity integration
putApiV4ProjectsIdIntegrationsGoogleCloudPlatformWorkloadIdentityFederation:
type: object
properties:
workload_identity_federation_project_id:
type: string
description: Google Cloud project ID for the Workload Identity Federation.
workload_identity_federation_project_number:
type: string
description: Google Cloud project number for the Workload Identity Federation.
workload_identity_pool_id:
type: string
description: ID of the Workload Identity Pool.
workload_identity_pool_provider_id:
type: string
description: ID of the Workload Identity Pool provider.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- workload_identity_federation_project_id
- workload_identity_federation_project_number
- workload_identity_pool_id
- workload_identity_pool_provider_id
description: Create/Edit Google Cloud Platform Workload Identity Federation integration
putApiV4ProjectsIdIntegrationsDiscord:
type: object
properties:
webhook:
type: string
description: Discord webhook (for example, `https://discord.com/api/webhooks/…`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_channel:
type: string
description: The name of the channel to receive push_events notifications
issue_channel:
type: string
description: The name of the channel to receive issues_events notifications
incident_channel:
type: string
description: The name of the channel to receive incident_events notifications
alert_channel:
type: string
description: The name of the channel to receive alert_events notifications
confidential_issue_channel:
type: string
description: The name of the channel to receive confidential_issues_events notifications
merge_request_channel:
type: string
description: The name of the channel to receive merge_requests_events notifications
note_channel:
type: string
description: The name of the channel to receive note_events notifications
confidential_note_channel:
type: string
description: The name of the channel to receive confidential_note_events notifications
tag_push_channel:
type: string
description: The name of the channel to receive tag_push_events notifications
deployment_channel:
type: string
description: The name of the channel to receive deployment_events notifications
pipeline_channel:
type: string
description: The name of the channel to receive pipeline_events notifications
wiki_page_channel:
type: string
description: The name of the channel to receive wiki_page_events notifications
vulnerability_channel:
type: string
description: The name of the channel to receive vulnerability_events notifications
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
deployment_events:
type: boolean
description: Trigger event when a deployment starts or finishes.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Discord integration
putApiV4ProjectsIdServicesGoogleCloudPlatformWorkloadIdentityFederation:
type: object
properties:
workload_identity_federation_project_id:
type: string
description: Google Cloud project ID for the Workload Identity Federation.
workload_identity_federation_project_number:
type: string
description: Google Cloud project number for the Workload Identity Federation.
workload_identity_pool_id:
type: string
description: ID of the Workload Identity Pool.
workload_identity_pool_provider_id:
type: string
description: ID of the Workload Identity Pool provider.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- workload_identity_federation_project_id
- workload_identity_federation_project_number
- workload_identity_pool_id
- workload_identity_pool_provider_id
description: Create/Edit Google Cloud Platform Workload Identity Federation integration
putApiV4ProjectsIdServicesJenkins:
type: object
properties:
enable_ssl_verification:
type: boolean
description: Enable SSL verification. Defaults to `true` (enabled).
jenkins_url:
type: string
description: URL of the Jenkins server.
project_name:
type: string
description: Name of the Jenkins project.
username:
type: string
description: Username of the Jenkins server.
password:
type: string
description: Password of the Jenkins server.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- jenkins_url
- project_name
description: Create/Edit Jenkins integration
putApiV4ProjectsIdServicesGitGuardian:
type: object
properties:
token:
type: string
description: Personal access token to authenticate calls to the GitGuardian API.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
description: Create/Edit Git Guardian integration
putApiV4ProjectsIdServicesPushover:
type: object
properties:
api_key:
type: string
description: The application key.
user_key:
type: string
description: The user key.
device:
type: string
description: Leave blank for all active devices.
priority:
type: string
description: The priority.
sound:
type: string
description: The sound of the notification.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- api_key
- user_key
- priority
description: Create/Edit Pushover integration
putApiV4ProjectsIdServicesMatrix:
type: object
properties:
hostname:
type: string
description: Custom hostname of the Matrix server. The default value is `https://matrix-client.matrix.org`.
token:
type: string
description: The Matrix access token (for example, `syt-zyx57W2v1u123ew11`).
room:
type: string
description: Unique identifier for the target room (in the format `!qPKKM111FFKKsfoCVy:matrix.org`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- room
description: Create/Edit Matrix integration
putApiV4GroupsIdIntegrationsCustomIssueTracker:
type: object
properties:
project_url:
type: string
description: URL of the project.
issues_url:
type: string
description: URL of the issue.
new_issue_url:
type: string
description: URL of the new issue.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- project_url
- issues_url
- new_issue_url
description: Create/Edit Custom Issue Tracker integration
putApiV4GroupsIdIntegrationsTelegram:
type: object
properties:
hostname:
type: string
description: Custom hostname of the Telegram API. The default value is `https://api.telegram.org`.
token:
type: string
description: The Telegram bot token (for example, `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`).
room:
type: string
description: Unique identifier for the target chat or the username of the target channel (in the format `@channelusername`).
thread:
type: string
description: Unique identifier for the target message thread (topic in a forum supergroup).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
incident_events:
type: boolean
description: Trigger event when an incident is created.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
vulnerability_events:
type: boolean
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- token
- room
description: Create/Edit Telegram integration
putApiV4GroupsIdIntegrationsZentao:
type: object
properties:
url:
type: string
description: Base URL of the ZenTao instance.
api_url:
type: string
description: If different from Web URL.
api_token:
type: string
zentao_product_xid:
type: string
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- url
- api_token
- zentao_product_xid
description: Create/Edit Zentao integration
putApiV4ProjectsIdServicesUnifyCircuit:
type: object
properties:
webhook:
type: string
description: The Unify Circuit webhook (for example, `https://circuit.com/rest/v2/webhooks/incoming/...`).
notify_only_broken_pipelines:
type: boolean
description: Send notifications for broken pipelines.
notify_only_when_pipeline_status_changes:
type: boolean
description: Send notifications only when the pipeline status changes.
branches_to_be_notified:
type: string
description: Branches to send notifications for. Valid options are `all`, `default`, `protected`, and `default_and_protected`. The default value is `default`.
push_events:
type: boolean
description: Trigger event for pushes to the repository.
issues_events:
type: boolean
description: Trigger event when a work item is created, updated, or closed.
confidential_issues_events:
type: boolean
description: Trigger event when a confidential work item is created, updated, or closed.
work_item_events:
type: boolean
confidential_work_item_events:
type: boolean
merge_requests_events:
type: boolean
description: Trigger event when a merge request is created, updated, or merged.
note_events:
type: boolean
description: Trigger event for new comments.
confidential_note_events:
type: boolean
description: Trigger event for new comments on confidential work items.
tag_push_events:
type: boolean
description: Trigger event for new tags pushed to the repository.
pipeline_events:
type: boolean
description: Trigger event when a pipeline status changes.
wiki_page_events:
type: boolean
description: Trigger event when a wiki page is created or updated.
use_inherited_settings:
type: boolean
description: Indicates whether to inherit the default settings. Defaults to `false`.
required:
- webhook
description: Create/Edit Unify Circuit integration
securityDefinitions:
access_token_header:
type: apiKey
name: PRIVATE-TOKEN
in: header
access_token_query:
type: apiKey
name: private_token
in: query