Project integrations API | GitLab Docs
/ Project integrations API Tier : Free, Premium, Ultimate Offering : GitLab.com, GitLab Self-Managed, GitLab Dedicated Use this API to manage integrations for a project. Prerequisites: You must have the Maintainer or Owner role for the project. List all active integrations inherited field introduced in GitLab 17.2 with a feature flag named integration_api_inheritance . Disabled by default. inherited field generally available in GitLab 17.3.
Feature flag integration_api_inheritance removed. Get a list of all active project integrations. The vulnerability_events field is only available for GitLab Enterprise Edition. GET /projects/:id/integrations Example response: 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 use_inherited_settings parameter introduced in GitLab 17.2 with a feature flag named integration_api_inheritance .
Disabled by default. use_inherited_settings parameter generally available in GitLab 17.3. Feature flag integration_api_inheritance removed. Set up Apple App Store Connect Set up the Apple App Store Connect integration for a project. PUT /projects/:id/integrations/apple_app_store Parameters: Parameter Type Required Description app_store_issuer_id string yes Apple App Store Connect issuer ID. app_store_key_id string yes Apple App Store Connect key ID. app_store_private_key_file_name string yes Apple App Store Connect private key filename. app_store_private_key string yes Apple App Store Connect private key. app_store_protected_refs boolean no Set variables on protected branches and tags only. use_inherited_settings boolean no Indicates whether to inherit the default settings.
Defaults to false . Disable Apple App Store Connect Disable the Apple App Store Connect integration for a project. Integration settings are reset. DELETE /projects/:id/integrations/apple_app_store Get Apple App Store Connect settings Get the Apple App Store Connect integration settings for a project. GET /projects/:id/integrations/apple_app_store Asana use_inherited_settings parameter introduced in GitLab 17.2 with a feature flag named integration_api_inheritance .
Disabled by default. use_inherited_settings parameter generally available in GitLab 17.3. Feature flag integration_api_inheritance removed. Set up Asana Set up the Asana integration for a project. PUT /projects/:id/integrations/asana Parameters: Parameter Type Required Description api_key string yes User API token. The user must have access to the task. All comments are attributed to this user. restrict_to_branch string no Comma-separated list of branches to be automatically inspected.
Leave blank to include all branches. use_inherited_settings boolean no Indicates whether to inherit the default settings. Defaults to false . Disable Asana Disable the Asana integration for a project. Integration settings are reset. DELETE /projects/:id/integrations/asana Get Asana settings Get the Asana integration settings for a project. GET /projects/:id/integrations/asana Assembla use_inherited_settings parameter introduced in GitLab 17.2 with a feature flag named integration_api_inheritance .
Disabled by default. use_inherited_settings parameter generally available in GitLab 17.3. Feature flag integration_api_inheritance removed. Set up Assembla Set up the Assembla integration for a project. PUT /projects/:id/integrations/assembla Parameters: Parameter Type Required Description token string yes The authentication token. subdomain string no The subdomain setting. use_inherited_settings boolean no Indicates whether to inherit the default settings.
Defaults to false . Disable Assembla Disable the Assembla integration for a project. Integration settings are reset. DELETE /projects/:id/integrations/assembla Get Assembla settings Get the Assembla integration settings for a project. GET /projects/:id/integrations/assembla Atlassian Bamboo use_inherited_settings parameter introduced in GitLab 17.2 with a feature flag named integration_api_inheritance . Disabled by default. use_inherited_settings parameter generally available in GitLab 17.3.
Feature flag integration_api_inheritance removed. Set up Atlassian Bamboo Set up the Atlassian Bamboo integration for a project. You must configure automatic revision labeling and a repository trigger in Bamboo. PUT /projects/:id/integrations/bamboo Parameters: Parameter Type Required Description bamboo_url string yes Bamboo root URL (for example, https://bamboo.example.com ). enable_ssl_verification boolean no Enable SSL verification.
Defaults to true (enabled). build_key string yes Bamboo build plan key (for example, KEY ). username string yes User with API access to the Bamboo server. password string yes Password of the user. use_inherited_settings boolean no Indicates whether to inherit the default settings. Defaults to false . Disable Atlassian Bamboo Disable the Atlassian Bamboo integration for a project. Integration settings are reset. DELETE /projects/:id/integrations/bamboo Get Atlassian Bamboo settings Get the Atlassian Bamboo integration settings for a project.
GET /projects/:id/integrations/bamboo Bugzilla use_inherited_settings parameter introduced in GitLab 17.2 with a feature flag named integration_api_inheritance . Disabled by default. use_inherited_settings parameter generally available in GitLab 17.3. Feature flag integration_api_inheritance removed. Set up Bugzilla Set up the Bugzilla integration for a project. PUT /projects/:id/integrations/bugzilla Parameters: Parameter Type Required Description new_issue_url string yes URL of the new issue. issues_url string yes URL of the issue. project_url string yes URL of the project. use_inherited_settings boolean no Indicates whether to inherit the default settings.
Defaults to false . Disable Bugzilla Disable the Bugzilla integration for a project. Integration settings are reset. DELETE /projects/:id/integrations/bugzilla Get Bugzilla settings Get the Bugzilla integration settings for a project. GET /projects/:id/integrations/bugzilla Buildkite use_inherited_settings parameter introduced in GitLab 17.2 with a feature flag named integration_api_inheritance . Disabled by default. use_inherited_settings parameter generally available in GitLab 17.3.
Feature flag integration_api_inheritance removed. Set up Buildkite Set up the Buildkite integration for a project. PUT /projects/:id/integrations/buildkite Parameters: Parameter Type Required Description token string yes Token you get after you create a Buildkite pipeline with a GitLab repository. project_url string yes Pipeline URL (for example, https://buildkite.com/example/pipeline ). enable_ssl_verification boolean no Deprecated : This parameter has no effect because SSL verification is always enabled. push_events boolean no Enable notifications for push events. merge_requests_
The rest of this page is on the live site.