ContextQMD
Back to Gitlabhq

API des intégrations de projet

doc-locale/fr-fr/api/project_integrations.md

19.3.0118.2 KB
Original Source

{{< details >}}

  • Édition : Gratuite, GitLab Premium, GitLab Ultimate
  • Offre : GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

Utilisez cette API pour gérer les intégrations d'un projet.

Prérequis :

  • Vous devez avoir le rôle Maintainer ou Owner pour le projet.

Lister toutes les intégrations actives {#list-all-active-integrations}

{{< history >}}

  • Le champ vulnerability_events a été introduit dans GitLab 16.4.
  • Le champ inherited a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le champ inherited est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Obtenez une liste de toutes les intégrations de projet actives. Le champ vulnerability_events est uniquement disponible pour GitLab Enterprise Edition.

plaintext
GET /projects/:id/integrations

Exemple de réponse :

json
[
  {
    "id": 75,
    "title": "Jenkins CI",
    "slug": "jenkins",
    "created_at": "2019-11-20T11:20:25.297Z",
    "updated_at": "2019-11-20T12:24:37.498Z",
    "active": true,
    "commit_events": true,
    "push_events": true,
    "issues_events": true,
    "alert_events": true,
    "confidential_issues_events": true,
    "merge_requests_events": true,
    "tag_push_events": false,
    "deployment_events": false,
    "note_events": true,
    "confidential_note_events": true,
    "pipeline_events": true,
    "wiki_page_events": true,
    "job_events": true,
    "comment_on_event_enabled": true,
    "inherited": false,
    "vulnerability_events": true
  },
  {
    "id": 76,
    "title": "Alerts endpoint",
    "slug": "alerts",
    "created_at": "2019-11-20T11:20:25.297Z",
    "updated_at": "2019-11-20T12:24:37.498Z",
    "active": true,
    "commit_events": true,
    "push_events": true,
    "issues_events": true,
    "alert_events": true,
    "confidential_issues_events": true,
    "merge_requests_events": true,
    "tag_push_events": true,
    "deployment_events": false,
    "note_events": true,
    "confidential_note_events": true,
    "pipeline_events": true,
    "wiki_page_events": true,
    "job_events": true,
    "comment_on_event_enabled": true,
    "inherited": false,
    "vulnerability_events": true
  }
]

Apple App Store Connect {#apple-app-store-connect}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Apple App Store Connect {#set-up-apple-app-store-connect}

Configurez l'intégration Apple App Store Connect pour un projet.

plaintext
PUT /projects/:id/integrations/apple_app_store

Paramètres :

ParamètreTypeObligatoireDescription
app_store_issuer_idstringouiID de l'émetteur Apple App Store Connect.
app_store_key_idstringouiID de clé Apple App Store Connect.
app_store_private_key_file_namestringouiNom du fichier de clé privée Apple App Store Connect.
app_store_private_keystringouiClé privée Apple App Store Connect.
app_store_protected_refsbooleannonDéfinir des variables uniquement sur les branches et les tags protégés.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Apple App Store Connect {#disable-apple-app-store-connect}

Désactivez l'intégration Apple App Store Connect pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/apple_app_store

Obtenir les paramètres Apple App Store Connect {#get-apple-app-store-connect-settings}

Obtenez les paramètres d'intégration Apple App Store Connect pour un projet.

plaintext
GET /projects/:id/integrations/apple_app_store

Asana {#asana}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Asana {#set-up-asana}

Configurez l'intégration Asana pour un projet.

plaintext
PUT /projects/:id/integrations/asana

Paramètres :

ParamètreTypeObligatoireDescription
api_keystringouiJeton d'API utilisateur. L'utilisateur doit avoir accès à la tâche. Tous les commentaires sont attribués à cet utilisateur.
restrict_to_branchstringnonListe de branches séparées par des virgules à inspecter automatiquement. Laissez vide pour inclure toutes les branches.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Asana {#disable-asana}

Désactivez l'intégration Asana pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/asana

Obtenir les paramètres Asana {#get-asana-settings}

Obtenez les paramètres d'intégration Asana pour un projet.

plaintext
GET /projects/:id/integrations/asana

Assembla {#assembla}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Assembla {#set-up-assembla}

Configurez l'intégration Assembla pour un projet.

plaintext
PUT /projects/:id/integrations/assembla

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiLe jeton d'authentification.
subdomainstringnonLe paramètre de sous-domaine.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Assembla {#disable-assembla}

Désactivez l'intégration Assembla pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/assembla

Obtenir les paramètres Assembla {#get-assembla-settings}

Obtenez les paramètres d'intégration Assembla pour un projet.

plaintext
GET /projects/:id/integrations/assembla

Atlassian Bamboo {#atlassian-bamboo}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Atlassian Bamboo {#set-up-atlassian-bamboo}

Configurez l'intégration Atlassian Bamboo pour un projet.

Vous devez configurer l'étiquetage automatique des révisions et un déclencheur de dépôt dans Bamboo.

plaintext
PUT /projects/:id/integrations/bamboo

Paramètres :

ParamètreTypeObligatoireDescription
bamboo_urlstringouiURL racine de Bamboo (par exemple, https://bamboo.example.com).
enable_ssl_verificationbooleannonActiver la vérification SSL. La valeur par défaut est true (activé).
build_keystringouiClé du plan de build Bamboo (par exemple, KEY).
usernamestringouiUtilisateur disposant d'un accès API au serveur Bamboo.
passwordstringouiMot de passe de l'utilisateur.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Atlassian Bamboo {#disable-atlassian-bamboo}

Désactivez l'intégration Atlassian Bamboo pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/bamboo

Obtenir les paramètres Atlassian Bamboo {#get-atlassian-bamboo-settings}

Obtenez les paramètres d'intégration Atlassian Bamboo pour un projet.

plaintext
GET /projects/:id/integrations/bamboo

Bugzilla {#bugzilla}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Bugzilla {#set-up-bugzilla}

Configurez l'intégration Bugzilla pour un projet.

plaintext
PUT /projects/:id/integrations/bugzilla

Paramètres :

ParamètreTypeObligatoireDescription
new_issue_urlstringouiURL du nouveau ticket.
issues_urlstringouiURL du ticket.
project_urlstringouiURL du projet.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Bugzilla {#disable-bugzilla}

Désactivez l'intégration Bugzilla pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/bugzilla

Obtenir les paramètres Bugzilla {#get-bugzilla-settings}

Obtenez les paramètres d'intégration Bugzilla pour un projet.

plaintext
GET /projects/:id/integrations/bugzilla

Buildkite {#buildkite}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Buildkite {#set-up-buildkite}

Configurez l'intégration Buildkite pour un projet.

plaintext
PUT /projects/:id/integrations/buildkite

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiJeton obtenu après la création d'un pipeline Buildkite avec un dépôt GitLab.
project_urlstringouiURL du pipeline (par exemple, https://buildkite.com/example/pipeline).
enable_ssl_verificationbooleannonDéprécié : Ce paramètre n'a aucun effet car la vérification SSL est toujours activée.
push_eventsbooleannonActiver les notifications pour les événements de push.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Buildkite {#disable-buildkite}

Désactivez l'intégration Buildkite pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/buildkite

Obtenir les paramètres Buildkite {#get-buildkite-settings}

Obtenez les paramètres d'intégration Buildkite pour un projet.

plaintext
GET /projects/:id/integrations/buildkite

Campfire Classic {#campfire-classic}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Vous pouvez vous intégrer à Campfire Classic. Cependant, Campfire Classic est un ancien produit qui n'est plus vendu par Basecamp.

Configurer Campfire Classic {#set-up-campfire-classic}

Configurez l'intégration Campfire Classic pour un projet.

plaintext
PUT /projects/:id/integrations/campfire

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiJeton d'authentification API de Campfire Classic. Pour obtenir le jeton, connectez-vous à Campfire Classic et sélectionnez My info.
subdomainstringnonSous-domaine .campfirenow.com lorsque vous êtes connecté.
roomstringnonPartie ID de l'URL de la salle Campfire Classic.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Campfire Classic {#disable-campfire-classic}

Désactivez l'intégration Campfire Classic pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/campfire

Obtenir les paramètres Campfire Classic {#get-campfire-classic-settings}

Obtenez les paramètres d'intégration Campfire Classic pour un projet.

plaintext
GET /projects/:id/integrations/campfire

ClickUp {#clickup}

{{< history >}}

  • Introduit dans GitLab 16.1.
  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer ClickUp {#set-up-clickup}

Configurez l'intégration ClickUp pour un projet.

plaintext
PUT /projects/:id/integrations/clickup

Paramètres :

ParamètreTypeObligatoireDescription
issues_urlstringouiURL du ticket.
project_urlstringouiURL du projet.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver ClickUp {#disable-clickup}

Désactivez l'intégration ClickUp pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/clickup

Obtenir les paramètres ClickUp {#get-clickup-settings}

Obtenez les paramètres d'intégration ClickUp pour un projet.

plaintext
GET /projects/:id/integrations/clickup

Confluence Workspace {#confluence-workspace}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Utilisez un Confluence Cloud Workspace comme wiki de votre projet.

Configurer Confluence Workspace {#set-up-confluence-workspace}

Configurez l'intégration Confluence Workspace pour un projet.

plaintext
PUT /projects/:id/integrations/confluence

Paramètres :

ParamètreTypeObligatoireDescription
confluence_urlstringouiURL du Confluence Workspace hébergé sur atlassian.net.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Confluence Workspace {#disable-confluence-workspace}

Désactivez l'intégration Confluence Workspace pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/confluence

Obtenir les paramètres Confluence Workspace {#get-confluence-workspace-settings}

Obtenez les paramètres d'intégration Confluence Workspace pour un projet.

plaintext
GET /projects/:id/integrations/confluence

Outil de suivi de tickets personnalisé {#custom-issue-tracker}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer un outil de suivi de tickets personnalisé {#set-up-a-custom-issue-tracker}

Configurez un outil de suivi de tickets personnalisé pour un projet.

plaintext
PUT /projects/:id/integrations/custom-issue-tracker

Paramètres :

ParamètreTypeObligatoireDescription
new_issue_urlstringouiURL du nouveau ticket.
issues_urlstringouiURL du ticket.
project_urlstringouiURL du projet.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver un outil de suivi de tickets personnalisé {#disable-a-custom-issue-tracker}

Désactivez un outil de suivi de tickets personnalisé pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/custom-issue-tracker

Obtenir les paramètres de l'outil de suivi de tickets personnalisé {#get-custom-issue-tracker-settings}

Obtenez les paramètres de l'outil de suivi de tickets personnalisé pour un projet.

plaintext
GET /projects/:id/integrations/custom-issue-tracker

Datadog {#datadog}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Datadog {#set-up-datadog}

Configurez l'intégration Datadog pour un projet.

plaintext
PUT /projects/:id/integrations/datadog

Paramètres :

ParamètreTypeObligatoireDescription
api_keystringouiClé d'API utilisée pour l'authentification auprès de Datadog.
datadog_ci_visibilitybooleanouiActive la collecte des événements de pipeline et de job dans Datadog pour afficher les traces d'exécution de pipeline.
api_urlstringnonURL complète de votre site Datadog.
datadog_envstringnonPour les déploiements auto-gérés, tag env% pour toutes les données envoyées à Datadog.
datadog_servicestringnonInstance GitLab pour taguer toutes les données dans Datadog. Peut être utilisé lors de la gestion de plusieurs déploiements auto-gérés.
datadog_sitestringnonSite Datadog vers lequel envoyer des données. Pour envoyer des données au site EU, utilisez datadoghq.eu.
datadog_tagsstringnonTags personnalisés dans Datadog. Spécifiez un tag par ligne au format key:value\nkey2:value2.
archive_trace_eventsbooleannonLorsqu'activé, les job logs sont collectés par Datadog et affichés avec les traces d'exécution de pipeline (introduit dans GitLab 15.3).
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Datadog {#disable-datadog}

Désactivez l'intégration Datadog pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/datadog

Obtenir les paramètres Datadog {#get-datadog-settings}

Obtenez les paramètres d'intégration Datadog pour un projet.

plaintext
GET /projects/:id/integrations/datadog

Diffblue Cover {#diffblue-cover}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Diffblue Cover {#set-up-diffblue-cover}

Configurez l'intégration Diffblue Cover pour un projet.

plaintext
PUT /projects/:id/integrations/diffblue-cover

Paramètres :

ParamètreTypeObligatoireDescription
diffblue_license_keystringouiClé de licence Diffblue Cover.
diffblue_access_token_namestringouiNom du jeton d'accès utilisé par Diffblue Cover dans les pipelines.
diffblue_access_token_secretstringouiSecret du jeton d'accès utilisé par Diffblue Cover dans les pipelines.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Diffblue Cover {#disable-diffblue-cover}

Désactivez l'intégration Diffblue Cover pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/diffblue-cover

Obtenir les paramètres Diffblue Cover {#get-diffblue-cover-settings}

Obtenez les paramètres d'intégration Diffblue Cover pour un projet.

plaintext
GET /projects/:id/integrations/diffblue-cover

Discord Notifications {#discord-notifications}

{{< history >}}

  • Les paramètres _channel ont été introduits dans GitLab 16.3.
  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Discord Notifications {#set-up-discord-notifications}

Configurez Discord Notifications pour un projet.

plaintext
PUT /projects/:id/integrations/discord

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiWebhook Discord (par exemple, https://discord.com/api/webhooks/...).
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
confidential_issue_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de tickets confidentiels.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
confidential_note_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de notes confidentielles.
deployment_eventsbooleannonActiver les notifications pour les événements de déploiement.
deployment_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de déploiement.
group_confidential_mentions_eventsbooleannonActiver les notifications pour les événements de mentions confidentielles de groupe.
group_confidential_mentions_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de mentions confidentielles de groupe.
group_mentions_eventsbooleannonActiver les notifications pour les événements de mentions de groupe.
group_mentions_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de mentions de groupe.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
issue_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de tickets.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
merge_request_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de merge request.
note_eventsbooleannonActiver les notifications pour les événements de notes.
note_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de notes.
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
pipeline_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de pipeline.
push_eventsbooleannonActiver les notifications pour les événements de push.
push_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de push.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
tag_push_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de push de tags.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
wiki_page_channelstringnonLe webhook de remplacement pour recevoir des notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Discord Notifications {#disable-discord-notifications}

Désactivez Discord Notifications pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/discord

Obtenir les paramètres Discord Notifications {#get-discord-notifications-settings}

Obtenez les paramètres Discord Notifications pour un projet.

plaintext
GET /projects/:id/integrations/discord

Drone {#drone}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Drone {#set-up-drone}

Configurez l'intégration Drone pour un projet.

plaintext
PUT /projects/:id/integrations/drone-ci

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiJeton Drone CI.
drone_urlstringouiURL de Drone CI (par exemple, http://drone.example.com).
enable_ssl_verificationbooleannonActiver la vérification SSL. La valeur par défaut est true (activé).
push_eventsbooleannonActiver les notifications pour les événements de push.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Drone {#disable-drone}

Désactivez l'intégration Drone pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/drone-ci

Obtenir les paramètres Drone {#get-drone-settings}

Obtenez les paramètres d'intégration Drone pour un projet.

plaintext
GET /projects/:id/integrations/drone-ci

E-mails lors du push {#emails-on-push}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les e-mails lors du push {#set-up-emails-on-push}

Configurez l'intégration e-mails lors du push pour un projet.

plaintext
PUT /projects/:id/integrations/emails-on-push

Paramètres :

ParamètreTypeObligatoireDescription
recipientsstringouiE-mails séparés par des espaces.
disable_diffsbooleannonDésactiver les diffs de code.
send_from_committer_emailbooleannonEnvoyer depuis le committer.
push_eventsbooleannonActiver les notifications pour les événements de push.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. Les notifications sont toujours envoyées pour les pushs de tags. La valeur par défaut est all.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver les e-mails lors du push {#disable-emails-on-push}

Désactivez l'intégration e-mails lors du push pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/emails-on-push

Obtenir les paramètres des e-mails lors du push {#get-emails-on-push-settings}

Obtenez les paramètres d'intégration des e-mails lors du push pour un projet.

plaintext
GET /projects/:id/integrations/emails-on-push

Engineering Workflow Management (EWM) {#engineering-workflow-management-ewm}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer EWM {#set-up-ewm}

Configurez l'intégration EWM pour un projet.

plaintext
PUT /projects/:id/integrations/ewm

Paramètres :

ParamètreTypeObligatoireDescription
new_issue_urlstringouiURL du nouveau ticket.
project_urlstringouiURL du projet.
issues_urlstringouiURL du ticket.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver EWM {#disable-ewm}

Désactivez l'intégration EWM pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/ewm

Obtenir les paramètres EWM {#get-ewm-settings}

Obtenez les paramètres d'intégration EWM pour un projet.

plaintext
GET /projects/:id/integrations/ewm

Wiki externe {#external-wiki}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer un wiki externe {#set-up-an-external-wiki}

Configurez un wiki externe pour un projet.

plaintext
PUT /projects/:id/integrations/external-wiki

Paramètres :

ParamètreTypeObligatoireDescription
external_wiki_urlstringouiURL du wiki externe.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver un wiki externe {#disable-an-external-wiki}

Désactivez un wiki externe pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/external-wiki

Obtenir les paramètres du wiki externe {#get-external-wiki-settings}

Obtenez les paramètres du wiki externe pour un projet.

plaintext
GET /projects/:id/integrations/external-wiki

GitGuardian {#gitguardian}

{{< details >}}

  • Édition : Premium, Ultimate
  • Offre : GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

{{< /history >}}

GitGuardian est un service de cybersécurité qui détecte les données sensibles telles que les clés d'API et les mots de passe dans les dépôts de code source. Il analyse les dépôts Git, alerte sur les violations de politique et aide les organisations à résoudre les problèmes de sécurité avant que les pirates ne puissent les exploiter.

Vous pouvez configurer GitLab pour rejeter les commits basés sur les politiques de GitGuardian.

Pour les problèmes connus et les étapes de dépannage, consultez Dépannage de GitGuardian.

Configurer GitGuardian {#set-up-gitguardian}

Configurez l'intégration GitGuardian pour un projet.

plaintext
PUT /projects/:id/integrations/git-guardian

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiJeton d'API GitGuardian avec la portée scan.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver GitGuardian {#disable-gitguardian}

Désactivez l'intégration GitGuardian pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/git-guardian

Obtenir les paramètres GitGuardian {#get-gitguardian-settings}

Obtenez les paramètres d'intégration GitGuardian pour un projet.

plaintext
GET /projects/:id/integrations/git-guardian

GitHub {#github}

{{< details >}}

  • Édition : Premium, Ultimate
  • Offre : GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer GitHub {#set-up-github}

Configurez l'intégration GitHub pour un projet.

plaintext
PUT /projects/:id/integrations/github

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiJeton d'API GitHub avec la portée OAuth repo:status.
repository_urlstringouiURL du dépôt GitHub.
static_contextbooleannonAjouter le nom d'hôte de votre instance GitLab au nom de la vérification de statut.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver GitHub {#disable-github}

Désactiver l'intégration GitHub pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/github

Obtenir les paramètres GitHub {#get-github-settings}

Obtenir les paramètres d'intégration GitHub pour un projet.

plaintext
GET /projects/:id/integrations/github

GitLab pour l'application Jira Cloud {#gitlab-for-jira-cloud-app}

L'intégration de l'application GitLab pour Jira Cloud est activée ou désactivée automatiquement via la liaison et la dissociation de groupes dans Jira. Vous ne pouvez pas activer ou désactiver l'intégration avec le formulaire des intégrations GitLab ou l'API.

Mettre à jour l'intégration pour un projet {#update-integration-for-a-project}

Utilisez ce point de terminaison d'API pour mettre à jour une intégration que vous créez avec la liaison de groupe dans Jira.

plaintext
PUT /projects/:id/integrations/jira-cloud-app

Paramètres :

ParamètreTypeObligatoireDescription
jira_cloud_app_service_idsstringnonID de service Jira Service Management. Utilisez des virgules (,) pour séparer plusieurs ID.
jira_cloud_app_enable_deployment_gatingbooleannonActive le contrôle du déploiement pour les déploiements GitLab bloqués depuis Jira Service Management.
jira_cloud_app_deployment_gating_environmentsstringnonLes environnements (production, staging, testing ou development) pour lesquels activer le contrôle du déploiement. Obligatoire si le contrôle du déploiement est activé. Utilisez des virgules (,) pour séparer plusieurs environnements.

Obtenir les paramètres de l'application GitLab pour Jira Cloud {#get-gitlab-for-jira-cloud-app-settings}

Obtenir les paramètres d'intégration de l'application GitLab pour Jira Cloud pour un projet.

plaintext
GET /projects/:id/integrations/jira-cloud-app

Application GitLab pour Slack {#gitlab-for-slack-app}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer l'application GitLab pour Slack {#set-up-gitlab-for-slack-app}

Mettre à jour l'intégration de l'application GitLab pour Slack pour un projet.

Vous ne pouvez pas créer d'application GitLab pour Slack via l'API, car l'intégration nécessite un jeton OAuth 2.0 que vous ne pouvez pas obtenir uniquement depuis l'API GitLab. À la place, vous devez installer l'application depuis l'interface GitLab. Vous pouvez ensuite utiliser ce point de terminaison d'API pour mettre à jour l'intégration.

plaintext
PUT /projects/:id/integrations/gitlab-slack-application

Paramètres :

ParamètreTypeObligatoireDescription
channelstringnonCanal par défaut à utiliser si aucun autre canal n'est configuré.
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
notify_only_default_branchbooleannonDéprécié : Ce paramètre a été remplacé par branches_to_be_notified.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
alert_eventsbooleannonActiver les notifications pour les événements d'alerte.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
note_eventsbooleannonActiver les notifications pour les événements de notes.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
deployment_eventsbooleannonActiver les notifications pour les événements de déploiement.
incidents_eventsbooleannonActiver les notifications pour les événements d'incident.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
push_eventsbooleannonActiver les notifications pour les événements de push.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
vulnerability_eventsbooleannonActiver les notifications pour les événements de vulnérabilité.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
labels_to_be_notifiedstringnonLabels pour lesquels envoyer des notifications. Si non défini, recevez des notifications pour tous les événements.
labels_to_be_notified_behaviorstringnonLabels pour lesquels recevoir des notifications. Les options valides sont match_any et match_all. La valeur par défaut est match_any.
push_channelstringnonNom du canal pour recevoir les notifications des événements de push.
issue_channelstringnonNom du canal pour recevoir les notifications des événements de ticket.
confidential_issue_channelstringnonNom du canal pour recevoir les notifications des événements de ticket confidentiel.
merge_request_channelstringnonNom du canal pour recevoir les notifications des événements de merge request.
note_channelstringnonNom du canal pour recevoir les notifications des événements de note.
confidential_note_channelstringnonNom du canal pour recevoir les notifications des événements de note confidentielle.
tag_push_channelstringnonNom du canal pour recevoir les notifications des événements de push de tag.
pipeline_channelstringnonNom du canal pour recevoir les notifications des événements de pipeline.
wiki_page_channelstringnonNom du canal pour recevoir les notifications des événements de page wiki.
deployment_channelstringnonNom du canal pour recevoir les notifications des événements de déploiement.
incident_channelstringnonNom du canal pour recevoir les notifications des événements d'incident.
vulnerability_channelstringnonNom du canal pour recevoir les notifications des événements de vulnérabilité.
alert_channelstringnonNom du canal pour recevoir les notifications des événements d'alerte.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver l'application GitLab pour Slack {#disable-gitlab-for-slack-app}

Désactiver l'intégration de l'application GitLab pour Slack pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/gitlab-slack-application

Obtenir les paramètres de l'application GitLab pour Slack {#get-gitlab-for-slack-app-settings}

Obtenir les paramètres d'intégration de l'application GitLab pour Slack pour un projet.

plaintext
GET /projects/:id/integrations/gitlab-slack-application

Google Chat {#google-chat}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Google Chat {#set-up-google-chat}

Configurer l'intégration Google Chat pour un projet.

plaintext
PUT /projects/:id/integrations/hangouts-chat

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiLe webhook Hangouts Chat (par exemple, https://chat.googleapis.com/v1/spaces...).
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
notify_only_default_branchbooleannonDéprécié : Ce paramètre a été remplacé par branches_to_be_notified.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
push_eventsbooleannonActiver les notifications pour les événements de push.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
note_eventsbooleannonActiver les notifications pour les événements de notes.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
pipeline_eventsbooleannonActiver les notifications pour les év��nements de pipeline.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Google Chat {#disable-google-chat}

Désactiver l'intégration Google Chat pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/hangouts-chat

Obtenir les paramètres Google Chat {#get-google-chat-settings}

Obtenir les paramètres d'intégration Google Chat pour un projet.

plaintext
GET /projects/:id/integrations/hangouts-chat

Google Artifact Management {#google-artifact-management}

{{< details >}}

  • Édition : Gratuite, GitLab Premium, GitLab Ultimate
  • Offre : GitLab.com
  • Statut : Bêta

{{< /details >}}

{{< history >}}

  • Introduit dans GitLab 16.9 en tant que fonctionnalité bêta avec un indicateur nommé google_cloud_support_feature_flag. Désactivé par défaut.
  • Activé sur GitLab.com dans GitLab 17.1. L'indicateur de fonctionnalité google_cloud_support_feature_flag a été supprimé.
  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Cette fonctionnalité est en bêta.

Configurer Google Artifact Management {#set-up-google-artifact-management}

Configurer l'intégration Google Artifact Management pour un projet.

plaintext
PUT /projects/:id/integrations/google-cloud-platform-artifact-registry

Paramètres :

ParamètreTypeObligatoireDescription
artifact_registry_project_idstringouiID du projet Google Cloud.
artifact_registry_locationstringouiEmplacement du dépôt Artifact Registry.
artifact_registry_repositoriesstringouiDépôt Artifact Registry.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Google Artifact Management {#disable-google-artifact-management}

Désactiver l'intégration Google Artifact Management pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/google-cloud-platform-artifact-registry

Obtenir les paramètres Google Artifact Management {#get-google-artifact-management-settings}

Obtenir les paramètres d'intégration Google Artifact Management pour un projet.

plaintext
GET /projects/:id/integrations/google-cloud-platform-artifact-registry

Google Cloud Identity and Access Management (IAM) {#google-cloud-identity-and-access-management-iam}

{{< details >}}

  • Édition : Gratuite, GitLab Premium, GitLab Ultimate
  • Offre : GitLab.com
  • Statut : Bêta

{{< /details >}}

{{< history >}}

  • Introduit dans GitLab 16.10 en tant que fonctionnalité bêta avec un indicateur nommé google_cloud_support_feature_flag. Désactivé par défaut.
  • Activé sur GitLab.com dans GitLab 17.1. L'indicateur de fonctionnalité google_cloud_support_feature_flag a été supprimé.
  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Cette fonctionnalité est en bêta.

Configurer Google Cloud Identity and Access Management {#set-up-google-cloud-identity-and-access-management}

Configurer l'intégration Google Cloud Identity and Access Management pour un projet.

plaintext
PUT /projects/:id/integrations/google-cloud-platform-workload-identity-federation

Paramètres :

ParamètreTypeObligatoireDescription
workload_identity_federation_project_idstringouiID de projet Google Cloud pour la fédération d'identité de charge de travail (Workload Identity Federation).
workload_identity_federation_project_numberentierouiNuméro de projet Google Cloud pour la fédération d'identité de charge de travail (Workload Identity Federation).
workload_identity_pool_idstringouiID du pool d'identités de charge de travail.
workload_identity_pool_provider_idstringouiID du fournisseur du pool d'identités de charge de travail.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Google Cloud Identity and Access Management {#disable-google-cloud-identity-and-access-management}

Désactiver l'intégration Google Cloud Identity and Access Management pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/google-cloud-platform-workload-identity-federation

Obtenir Google Cloud Identity and Access Management {#get-google-cloud-identity-and-access-management}

Obtenir les paramètres de Google Cloud Identity and Access Management pour un projet.

plaintext
GET /projects/:id/integration/google-cloud-platform-workload-identity-federation

Google Play {#google-play}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Google Play {#set-up-google-play}

Configurer l'intégration Google Play pour un projet.

plaintext
PUT /projects/:id/integrations/google-play

Paramètres :

ParamètreTypeObligatoireDescription
package_namestringouiNom de package de l'application dans Google Play.
service_account_keystringouiClé du compte de service Google Play.
service_account_key_file_namestringouiNom de fichier de la clé du compte de service Google Play.
google_play_protected_refsbooleannonDéfinir des variables uniquement sur les branches et les tags protégés.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Google Play {#disable-google-play}

Désactiver l'intégration Google Play pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/google-play

Obtenir les paramètres Google Play {#get-google-play-settings}

Obtenir les paramètres d'intégration Google Play pour un projet.

plaintext
GET /projects/:id/integrations/google-play

Harbor {#harbor}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Harbor {#set-up-harbor}

Configurer l'intégration Harbor pour un projet.

plaintext
PUT /projects/:id/integrations/harbor

Paramètres :

ParamètreTypeObligatoireDescription
urlstringouiL'URL de base de l'instance Harbor liée au projet GitLab. Par exemple, https://demo.goharbor.io.
project_namestringouiLe nom du projet dans l'instance Harbor. Par exemple, testproject.
usernamestringouiLe nom d'utilisateur créé dans l'interface Harbor.
passwordstringouiLe mot de passe de l'utilisateur.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Harbor {#disable-harbor}

Désactiver l'intégration Harbor pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/harbor

Obtenir les paramètres Harbor {#get-harbor-settings}

Obtenir les paramètres d'intégration Harbor pour un projet.

plaintext
GET /projects/:id/integrations/harbor

irker (passerelle IRC) {#irker-irc-gateway}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer irker {#set-up-irker}

Configurer l'intégration irker pour un projet.

plaintext
PUT /projects/:id/integrations/irker

Paramètres :

ParamètreTypeObligatoireDescription
recipientsstringouiListe de canaux ou d'adresses e-mail séparés par des virgules.
default_irc_uristringnonURI à ajouter avant chaque destinataire. La valeur par défaut est irc://irc.network.net:6697/.
server_hoststringnonNom d'hôte du démon irker. La valeur par défaut est localhost.
server_portentiernonPort du démon irker. La valeur par défaut est 6659.
colorize_messagesbooleannonColoriser les messages.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver irker {#disable-irker}

Désactiver l'intégration irker pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/irker

Obtenir les paramètres irker {#get-irker-settings}

Obtenir les paramètres d'intégration irker pour un projet.

plaintext
GET /projects/:id/integrations/irker

Jenkins {#jenkins}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Jenkins {#set-up-jenkins}

Configurer l'intégration Jenkins pour un projet.

plaintext
PUT /projects/:id/integrations/jenkins

Paramètres :

ParamètreTypeObligatoireDescription
jenkins_urlstringouiURL du serveur Jenkins.
enable_ssl_verificationbooleannonActiver la vérification SSL. La valeur par défaut est true (activé).
project_namestringouiNom du projet Jenkins.
usernamestringnonNom d'utilisateur du serveur Jenkins.
passwordstringnonMot de passe du serveur Jenkins.
push_eventsbooleannonActive les notifications pour les événements de push.
merge_requests_eventsbooleannonActive les notifications pour les événements de merge request.
tag_push_eventsbooleannonActive les notifications pour les événements de push de tag.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Jenkins {#disable-jenkins}

Désactiver l'intégration Jenkins pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/jenkins

Obtenir les paramètres Jenkins {#get-jenkins-settings}

Obtenir les paramètres d'intégration Jenkins pour un projet.

plaintext
GET /projects/:id/integrations/jenkins

JetBrains TeamCity {#jetbrains-teamcity}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer JetBrains TeamCity {#set-up-jetbrains-teamcity}

Configurer l'intégration JetBrains TeamCity pour un projet.

La configuration de build dans TeamCity doit utiliser le format de numéro de build %build.vcs.number%. Dans les paramètres avancés de la racine VCS, configurez la surveillance de toutes les branches afin que les merge requests puissent être construites.

plaintext
PUT /projects/:id/integrations/teamcity

Paramètres :

ParamètreTypeObligatoireDescription
teamcity_urlstringouiURL racine de TeamCity (par exemple, https://teamcity.example.com).
enable_ssl_verificationbooleannonActiver la vérification SSL. La valeur par défaut est true (activé).
build_typestringouiL'ID de configuration de build du projet TeamCity.
usernamestringouiUn utilisateur disposant des autorisations nécessaires pour déclencher une build manuelle.
passwordstringouiLe mot de passe de l'utilisateur.
push_eventsbooleannonActiver les notifications pour les événements de push.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver JetBrains TeamCity {#disable-jetbrains-teamcity}

Désactiver l'intégration JetBrains TeamCity pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/teamcity

Obtenir les paramètres JetBrains TeamCity {#get-jetbrains-teamcity-settings}

Obtenir les paramètres d'intégration JetBrains TeamCity pour un projet.

plaintext
GET /projects/:id/integrations/teamcity

Tickets Jira {#jira-issues}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les tickets Jira {#set-up-jira-issues}

Configurer l'intégration des tickets Jira pour un projet.

plaintext
PUT /projects/:id/integrations/jira

Paramètres :

ParamètreTypeObligatoireDescription
urlstringouiL'URL du projet Jira lié à ce projet GitLab (par exemple, https://jira.example.com).
api_urlstringnonL'URL de base de l'API de l'instance Jira. La valeur de l'URL web est utilisée si non définie (par exemple, https://jira-api.example.com).
usernamestringnonL'adresse e-mail ou le nom d'utilisateur à utiliser avec Jira. Utilisez une adresse e-mail pour Jira Cloud, et un nom d'utilisateur pour Jira Data Center et Jira Server. Obligatoire lors de l'utilisation de l'authentification de base (jira_auth_type est 0).
passwordstringouiLe jeton d'API Jira, le mot de passe ou le jeton d'accès personnel à utiliser avec Jira. Lors de l'utilisation de l'authentification de base (jira_auth_type est 0), utilisez un jeton d'API pour Jira Cloud, et un mot de passe pour Jira Data Center ou Jira Server. Pour un jeton d'accès personnel Jira (jira_auth_type est 1), utilisez le jeton d'accès personnel.
jira_auth_typeentiernonLa méthode d'authentification à utiliser avec Jira. Utilisez 0 pour l'authentification de base, et 1 pour le jeton d'accès personnel Jira. La valeur par défaut est 0.
jira_issue_prefixstringnonPréfixe pour faire correspondre les clés de tickets Jira.
jira_issue_regexstringnonExpression régulière pour faire correspondre les clés de tickets Jira.
jira_issue_transition_automaticbooleannonActiver les transitions de tickets automatiques. A la priorité sur jira_issue_transition_id si activé. La valeur par défaut est false.
jira_issue_transition_idstringnonL'ID d'une ou plusieurs transitions pour les transitions de tickets personnalisées. Ignoré lorsque jira_issue_transition_automatic est activé. La valeur par défaut est une chaîne vide, ce qui désactive les transitions personnalisées.
commit_eventsbooleannonActiver les notifications pour les événements de commit.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
comment_on_event_enabledbooleannonActiver les commentaires dans les tickets Jira pour chaque événement GitLab (commit ou merge request).
issues_enabledbooleannonActiver la consultation des tickets Jira dans GitLab. Introduit dans GitLab 17.0.
project_keystableau de chaînesnonClés des projets Jira. Lorsque issues_enabled est true, ce paramètre spécifie les projets Jira à partir desquels consulter les tickets dans GitLab. Introduit dans GitLab 17.0.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.
vulnerabilities_enabledbooleannonDisponible uniquement dans GitLab EE. Lorsque défini sur true, crée des tickets Jira pour les vulnérabilités GitLab.
vulnerabilities_issuetypenumbernonDisponible uniquement dans GitLab EE. ID du type de ticket Jira à utiliser lors de la création de tickets à partir de vulnérabilités.
project_keystringnonDisponible uniquement dans GitLab EE. Clé du projet à utiliser lors de la création de tickets à partir de vulnérabilités. Ce paramètre est obligatoire si vous utilisez l'intégration pour créer des tickets à partir de vulnérabilités.
customize_jira_issue_enabledbooleannonDisponible uniquement dans GitLab EE. Lorsque défini sur true, ouvre un formulaire prérempli sur l'instance Jira lors de la création d'un ticket Jira à partir d'une vulnérabilité.

Désactiver Jira {#disable-jira}

Désactiver l'intégration des tickets Jira pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/jira

Obtenir les paramètres Jira {#get-jira-settings}

Obtenir les paramètres d'intégration des tickets Jira pour un projet.

plaintext
GET /projects/:id/integrations/jira

Linear {#linear}

{{< history >}}

{{< /history >}}

Configurer Linear {#set-up-linear}

Configurer l'intégration Linear pour un groupe.

plaintext
PUT /projects/:id/integrations/linear

Paramètres :

ParamètreTypeObligatoireDescription
workspace_urlstringouiURL du ticket.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités ou non. La valeur par défaut est false.

Désactiver Linear {#disable-linear}

Désactiver l'intégration Linear pour un groupe. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/linear

Obtenir les paramètres Linear {#get-linear-settings}

Obtenir les paramètres d'intégration Linear pour un groupe.

plaintext
GET /projects/:id/integrations/linear

Notifications Matrix {#matrix-notifications}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les notifications Matrix {#set-up-matrix-notifications}

Configurer les notifications Matrix pour un projet.

plaintext
PUT /projects/:id/integrations/matrix

Paramètres :

ParamètreTypeObligatoireDescription
hostnamestringnonNom d'hôte personnalisé du serveur Matrix. La valeur par défaut est https://matrix.org.
tokenstringouiLe jeton d'accès Matrix (par exemple, syt-zyx57W2v1u123ew11).
roomstringouiIdentifiant unique pour la salle cible (au format !qPKKM111FFKKsfoCVy:matrix.org).
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
push_eventsbooleannonActiver les notifications pour les événements de push.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
note_eventsbooleannonActiver les notifications pour les événements de notes.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver les notifications Matrix {#disable-matrix-notifications}

Désactiver les notifications Matrix pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/matrix

Obtenir les paramètres des notifications Matrix {#get-matrix-notifications-settings}

Obtenir les paramètres des notifications Matrix pour un projet.

plaintext
GET /projects/:id/integrations/matrix

Notifications Mattermost {#mattermost-notifications}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les notifications Mattermost {#set-up-mattermost-notifications}

Configurer les notifications Mattermost pour un projet.

plaintext
PUT /projects/:id/integrations/mattermost

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiWebhook des notifications Mattermost (par exemple, http://mattermost.example.com/hooks/...).
usernamestringnonNom d'utilisateur des notifications Mattermost.
channelstringnonCanal par défaut à utiliser si aucun autre canal n'est configuré.
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
notify_only_default_branchbooleannonDéprécié : Ce paramètre a été remplacé par branches_to_be_notified.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
labels_to_be_notifiedstringnonLabels pour lesquels envoyer des notifications. Laissez vide pour recevoir des notifications pour tous les événements.
labels_to_be_notified_behaviorstringnonLabels pour lesquels recevoir des notifications. Les options valides sont match_any et match_all. La valeur par défaut est match_any.
push_eventsbooleannonActiver les notifications pour les événements de push.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
note_eventsbooleannonActiver les notifications pour les événements de notes.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
push_channelstringnonLe nom du canal pour recevoir les notifications des événements de push.
issue_channelstringnonLe nom du canal pour recevoir les notifications des événements de ticket.
confidential_issue_channelstringnonLe nom du canal pour recevoir les notifications des événements de ticket confidentiel.
merge_request_channelstringnonLe nom du canal pour recevoir les notifications des événements de merge request.
note_channelstringnonLe nom du canal pour recevoir les notifications des événements de note.
confidential_note_channelstringnonLe nom du canal pour recevoir les notifications des événements de note confidentielle.
tag_push_channelstringnonLe nom du canal pour recevoir les notifications des événements de push de tag.
pipeline_channelstringnonLe nom du canal pour recevoir les notifications des événements de pipeline.
wiki_page_channelstringnonLe nom du canal pour recevoir les notifications des événements de page wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver les notifications Mattermost {#disable-mattermost-notifications}

Désactiver les notifications Mattermost pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/mattermost

Obtenir les paramètres des notifications Mattermost {#get-mattermost-notifications-settings}

Obtenir les paramètres des notifications Mattermost pour un projet.

plaintext
GET /projects/:id/integrations/mattermost

Commandes slash Mattermost {#mattermost-slash-commands}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les commandes slash Mattermost {#set-up-mattermost-slash-commands}

Configurer les commandes slash Mattermost pour un projet.

plaintext
PUT /projects/:id/integrations/mattermost-slash-commands

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiLe token Mattermost.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver les commandes slash Mattermost {#disable-mattermost-slash-commands}

Désactiver les commandes slash Mattermost pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/mattermost-slash-commands

Obtenir les paramètres des commandes slash Mattermost {#get-mattermost-slash-commands-settings}

Obtenir les paramètres des commandes slash Mattermost pour un projet.

plaintext
GET /projects/:id/integrations/mattermost-slash-commands

Notifications Microsoft Teams {#microsoft-teams-notifications}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les notifications Microsoft Teams {#set-up-microsoft-teams-notifications}

Configurer les notifications Microsoft Teams pour un projet.

plaintext
PUT /projects/:id/integrations/microsoft-teams

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiLe webhook Microsoft Teams (par exemple, https://outlook.office.com/webhook/...).
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
notify_only_default_branchbooleannonDéprécié : Ce paramètre a été remplacé par branches_to_be_notified.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
push_eventsbooleannonActiver les notifications pour les événements de push.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
note_eventsbooleannonActiver les notifications pour les événements de notes.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver les notifications Microsoft Teams {#disable-microsoft-teams-notifications}

Désactiver les notifications Microsoft Teams pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/microsoft-teams

Obtenir les paramètres des notifications Microsoft Teams {#get-microsoft-teams-notifications-settings}

Obtenir les paramètres des notifications Microsoft Teams pour un projet.

plaintext
GET /projects/:id/integrations/microsoft-teams

Mock CI {#mock-ci}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Cette intégration n'est disponible que dans un environnement de développement. Pour un exemple de serveur Mock CI, voir gitlab-org/gitlab-mock-ci-service.

Configurer Mock CI {#set-up-mock-ci}

Configurer l'intégration Mock CI pour un projet.

plaintext
PUT /projects/:id/integrations/mock-ci

Paramètres :

ParamètreTypeObligatoireDescription
mock_service_urlstringouiURL de l'intégration Mock CI.
enable_ssl_verificationbooleannonActiver la vérification SSL. La valeur par défaut est true (activé).
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Mock CI {#disable-mock-ci}

Désactiver l'intégration Mock CI pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/mock-ci

Obtenir les paramètres de Mock CI {#get-mock-ci-settings}

Obtenir les paramètres de l'intégration Mock CI pour un projet.

plaintext
GET /projects/:id/integrations/mock-ci

Packagist {#packagist}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Packagist {#set-up-packagist}

Configurer l'intégration Packagist pour un projet.

plaintext
PUT /projects/:id/integrations/packagist

Paramètres :

ParamètreTypeObligatoireDescription
usernamestringouiNom d'utilisateur d'un compte Packagist.
tokenstringouiJeton API du serveur Packagist.
serverbooleannonURL du serveur Packagist. La valeur par défaut est https://packagist.org.
push_eventsbooleannonActiver les notifications pour les événements de push.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Packagist {#disable-packagist}

Désactiver l'intégration Packagist pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/packagist

Obtenir les paramètres de Packagist {#get-packagist-settings}

Obtenir les paramètres de l'intégration Packagist pour un projet.

plaintext
GET /projects/:id/integrations/packagist

Phorge {#phorge}

{{< history >}}

  • Introduit dans GitLab 16.11.
  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Phorge {#set-up-phorge}

Configurer l'intégration Phorge pour un projet.

plaintext
PUT /projects/:id/integrations/phorge

Paramètres :

ParamètreTypeObligatoireDescription
issues_urlstringouiURL du ticket.
project_urlstringouiURL du projet.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Phorge {#disable-phorge}

Désactiver l'intégration Phorge pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/phorge

Obtenir les paramètres de Phorge {#get-phorge-settings}

Obtenir les paramètres de l'intégration Phorge pour un projet.

plaintext
GET /projects/:id/integrations/phorge

E-mails de statut de pipeline {#pipeline-status-emails}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les e-mails de statut de pipeline {#set-up-pipeline-status-emails}

Configurer les e-mails de statut de pipeline pour un projet.

plaintext
PUT /projects/:id/integrations/pipelines-email

Paramètres :

ParamètreTypeObligatoireDescription
recipientsstringouiListe séparée par des virgules des adresses e-mail des destinataires.
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
notify_only_default_branchbooleannonEnvoyer des notifications pour la branche par défaut.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver les e-mails de statut de pipeline {#disable-pipeline-status-emails}

Désactiver les e-mails de statut de pipeline pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/pipelines-email

Obtenir les paramètres des e-mails de statut de pipeline {#get-pipeline-status-emails-settings}

Obtenir les paramètres des e-mails de statut de pipeline pour un projet.

plaintext
GET /projects/:id/integrations/pipelines-email

Pivotal Tracker {#pivotal-tracker}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Pivotal Tracker {#set-up-pivotal-tracker}

Configurer l'intégration Pivotal Tracker pour un projet.

plaintext
PUT /projects/:id/integrations/pivotaltracker

Paramètres :

ParamètreTypeObligatoireDescription
tokenstringouiLe token Pivotal Tracker.
restrict_to_branchbooleannonListe séparée par des virgules des branches à inspecter automatiquement. Laissez vide pour inclure toutes les branches.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Pivotal Tracker {#disable-pivotal-tracker}

Désactiver l'intégration Pivotal Tracker pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/pivotaltracker

Obtenir les paramètres de Pivotal Tracker {#get-pivotal-tracker-settings}

Obtenir les paramètres de l'intégration Pivotal Tracker pour un projet.

plaintext
GET /projects/:id/integrations/pivotaltracker

Pumble {#pumble}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Pumble {#set-up-pumble}

Configurer l'intégration Pumble pour un projet.

plaintext
PUT /projects/:id/integrations/pumble

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiLe webhook Pumble (par exemple, https://api.pumble.com/workspaces/x/...).
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
note_eventsbooleannonActiver les notifications pour les événements de notes.
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
push_eventsbooleannonActiver les notifications pour les événements de push.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Pumble {#disable-pumble}

Désactiver l'intégration Pumble pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/pumble

Obtenir les paramètres de Pumble {#get-pumble-settings}

Obtenir les paramètres de l'intégration Pumble pour un projet.

plaintext
GET /projects/:id/integrations/pumble

Pushover {#pushover}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Pushover {#set-up-pushover}

Configurer l'intégration Pushover pour un projet.

plaintext
PUT /projects/:id/integrations/pushover

Paramètres :

ParamètreTypeObligatoireDescription
api_keystringouiLa clé d'application.
user_keystringouiLa clé utilisateur.
prioritystringouiLa priorité.
devicestringnonLaissez vide pour tous les appareils actifs.
soundstringnonLe son de la notification.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Pushover {#disable-pushover}

Désactiver l'intégration Pushover pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/pushover

Obtenir les paramètres de Pushover {#get-pushover-settings}

Obtenir les paramètres de l'intégration Pushover pour un projet.

plaintext
GET /projects/:id/integrations/pushover

Redmine {#redmine}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Redmine {#set-up-redmine}

Configurer l'intégration Redmine pour un projet.

plaintext
PUT /projects/:id/integrations/redmine

Paramètres :

ParamètreTypeObligatoireDescription
new_issue_urlstringouiURL du nouveau ticket.
project_urlstringouiURL du projet.
issues_urlstringouiURL du ticket.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Redmine {#disable-redmine}

Désactiver l'intégration Redmine pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/redmine

Obtenir les paramètres de Redmine {#get-redmine-settings}

Obtenir les paramètres de l'intégration Redmine pour un projet.

plaintext
GET /projects/:id/integrations/redmine

Notifications Slack {#slack-notifications}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer les notifications Slack {#set-up-slack-notifications}

Configurer les notifications Slack pour un projet.

plaintext
PUT /projects/:id/integrations/slack

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiWebhook des notifications Slack (par exemple, https://hooks.slack.com/services/...).
usernamestringnonNom d'utilisateur des notifications Slack.
channelstringnonCanal par défaut à utiliser si aucun autre canal n'est configuré.
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
notify_only_default_branchbooleannonDéprécié : Ce paramètre a été remplacé par branches_to_be_notified.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
labels_to_be_notifiedstringnonLabels pour lesquels envoyer des notifications. Laissez vide pour recevoir des notifications pour tous les événements.
labels_to_be_notified_behaviorstringnonLabels pour lesquels recevoir des notifications. Les options valides sont match_any et match_all. La valeur par défaut est match_any.
alert_channelstringnonLe nom du canal pour recevoir les notifications des événements d'alerte.
alert_eventsbooleannonActiver les notifications pour les événements d'alerte.
commit_eventsbooleannonActiver les notifications pour les événements de commit.
confidential_issue_channelstringnonLe nom du canal pour recevoir les notifications des événements de ticket confidentiel.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
confidential_note_channelstringnonLe nom du canal pour recevoir les notifications des événements de note confidentielle.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
deployment_channelstringnonLe nom du canal pour recevoir les notifications des événements de déploiement.
deployment_eventsbooleannonActiver les notifications pour les événements de déploiement.
incident_channelstringnonLe nom du canal pour recevoir les notifications des événements d'incident.
incidents_eventsbooleannonActiver les notifications pour les événements d'incident.
issue_channelstringnonLe nom du canal pour recevoir les notifications des événements de ticket.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
job_eventsbooleannonActiver les notifications pour les événements de job.
merge_request_channelstringnonLe nom du canal pour recevoir les notifications des événements de merge request.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
note_channelstringnonLe nom du canal pour recevoir les notifications des événements de note.
note_eventsbooleannonActiver les notifications pour les événements de notes.
pipeline_channelstringnonLe nom du canal pour recevoir les notifications des événements de pipeline.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
push_channelstringnonLe nom du canal pour recevoir les notifications des événements de push.
push_eventsbooleannonActiver les notifications pour les événements de push.
tag_push_channelstringnonLe nom du canal pour recevoir les notifications des événements de push de tag.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
wiki_page_channelstringnonLe nom du canal pour recevoir les notifications des événements de page wiki.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver les notifications Slack {#disable-slack-notifications}

Désactiver les notifications Slack pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/slack

Obtenir les paramètres des notifications Slack {#get-slack-notifications-settings}

Obtenir les paramètres des notifications Slack pour un projet.

plaintext
GET /projects/:id/integrations/slack

Squash TM {#squash-tm}

{{< history >}}

  • Introduit dans GitLab 15.10.
  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Squash TM {#set-up-squash-tm}

Configurer les paramètres de l'intégration Squash TM pour un projet.

plaintext
PUT /projects/:id/integrations/squash-tm

Paramètres :

ParamètreTypeObligatoireDescription
urlstringouiURL du webhook Squash TM.
tokenstringnonToken secret.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Squash TM {#disable-squash-tm}

Désactiver l'intégration Squash TM pour un projet. Les paramètres d'intégration sont conservés.

plaintext
DELETE /projects/:id/integrations/squash-tm

Obtenir les paramètres de Squash TM {#get-squash-tm-settings}

Obtenir les paramètres de l'intégration Squash TM pour un projet.

plaintext
GET /projects/:id/integrations/squash-tm

Telegram {#telegram}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Telegram {#set-up-telegram}

Configurer l'intégration Telegram pour un projet.

plaintext
PUT /projects/:id/integrations/telegram

Paramètres :

ParamètreTypeObligatoireDescription
hostnamestringnonNom d'hôte personnalisé de l'API Telegram (introduit dans GitLab 17.1). La valeur par défaut est https://api.telegram.org.
tokenstringouiLe token du bot Telegram (par exemple, 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11).
roomstringouiIdentifiant unique du chat cible ou nom d'utilisateur du canal cible (au format @channelusername).
threadentiernonIdentifiant unique du fil de discussion cible (topic dans un supergroupe forum). Introduit dans GitLab 16.11.
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications (introduit dans GitLab 16.5). Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
push_eventsbooleanouiActiver les notifications pour les événements de push.
issues_eventsbooleanouiActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleanouiActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleanouiActiver les notifications pour les événements de merge request.
tag_push_eventsbooleanouiActiver les notifications pour les événements de push de tags.
note_eventsbooleanouiActiver les notifications pour les événements de notes.
confidential_note_eventsbooleanouiActiver les notifications pour les événements de notes confidentielles.
pipeline_eventsbooleanouiActiver les notifications pour les événements de pipeline.
wiki_page_eventsbooleanouiActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Telegram {#disable-telegram}

Désactiver l'intégration Telegram pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/telegram

Obtenir les paramètres de Telegram {#get-telegram-settings}

Obtenir les paramètres de l'intégration Telegram pour un projet.

plaintext
GET /projects/:id/integrations/telegram

Unify Circuit {#unify-circuit}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Unify Circuit {#set-up-unify-circuit}

Configurer l'intégration Unify Circuit pour un projet.

plaintext
PUT /projects/:id/integrations/unify-circuit

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiLe webhook Unify Circuit (par exemple, https://circuit.com/rest/v2/webhooks/incoming/...).
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
notify_only_when_pipeline_status_changesbooleannonEnvoyer des notifications uniquement lorsque le statut du pipeline pour la référence change.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
push_eventsbooleannonActiver les notifications pour les événements de push.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
note_eventsbooleannonActiver les notifications pour les événements de notes.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Unify Circuit {#disable-unify-circuit}

Désactiver l'intégration Unify Circuit pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/unify-circuit

Obtenir les paramètres Unify Circuit {#get-unify-circuit-settings}

Obtenir les paramètres d'intégration Unify Circuit pour un projet.

plaintext
GET /projects/:id/integrations/unify-circuit

Webex Teams {#webex-teams}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer Webex Teams {#set-up-webex-teams}

Configurer Webex Teams pour un projet.

plaintext
PUT /projects/:id/integrations/webex-teams

Paramètres :

ParamètreTypeObligatoireDescription
webhookstringouiLe webhook Webex Teams (par exemple, https://api.ciscospark.com/v1/webhooks/incoming/...).
notify_only_broken_pipelinesbooleannonEnvoyer des notifications pour les pipelines défaillants.
branches_to_be_notifiedstringnonBranches pour lesquelles envoyer des notifications. Les options valides sont all, default, protected et default_and_protected. La valeur par défaut est default.
push_eventsbooleannonActiver les notifications pour les événements de push.
issues_eventsbooleannonActiver les notifications pour les événements de tickets.
confidential_issues_eventsbooleannonActiver les notifications pour les événements de tickets confidentiels.
merge_requests_eventsbooleannonActiver les notifications pour les événements de merge request.
tag_push_eventsbooleannonActiver les notifications pour les événements de push de tags.
note_eventsbooleannonActiver les notifications pour les événements de notes.
confidential_note_eventsbooleannonActiver les notifications pour les événements de notes confidentielles.
pipeline_eventsbooleannonActiver les notifications pour les événements de pipeline.
wiki_page_eventsbooleannonActiver les notifications pour les événements de pages wiki.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver Webex Teams {#disable-webex-teams}

Désactiver Webex Teams pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/webex-teams

Obtenir les paramètres Webex Teams {#get-webex-teams-settings}

Obtenir les paramètres Webex Teams pour un projet.

plaintext
GET /projects/:id/integrations/webex-teams

YouTrack {#youtrack}

{{< history >}}

  • Le paramètre use_inherited_settings a été introduit dans GitLab 17.2 avec un indicateur nommé integration_api_inheritance. Désactivé par défaut.
  • Le paramètre use_inherited_settings est généralement disponible dans GitLab 17.3. L'indicateur de fonctionnalité integration_api_inheritance a été supprimé.

{{< /history >}}

Configurer YouTrack {#set-up-youtrack}

Configurer l'intégration YouTrack pour un projet.

plaintext
PUT /projects/:id/integrations/youtrack

Paramètres :

ParamètreTypeObligatoireDescription
issues_urlstringouiURL du ticket.
project_urlstringouiURL du projet.
use_inherited_settingsbooleannonIndique si les paramètres par défaut doivent être hérités. La valeur par défaut est false.

Désactiver YouTrack {#disable-youtrack}

Désactiver l'intégration YouTrack pour un projet. Les paramètres d'intégration sont réinitialisés.

plaintext
DELETE /projects/:id/integrations/youtrack

Obtenir les paramètres YouTrack {#get-youtrack-settings}

Obtenir les paramètres d'intégration YouTrack pour un projet.

plaintext
GET /projects/:id/integrations/youtrack