Update Existing Integration

Updates the existing parameters of the specified integration.

Only Jira admins can perform the Update Integration API call.

Update Existing Integration




Integer. Required.

This is the ID of the existing integration. For example, /integration/3.

Using the integrationId from the url, the Update Integration API will look for the integration with id : 3 and replaces integration properties according to the declared JSON request body structure file.




The Request body is a JSON structure similar to the Add New Integration API. Unlike the Update Existing Repository API, the id of the integration is substituted to the url as integrationId.




String. Optional. Some git hosts may require this to be filled in.

This is the name that will appear in the Git Integration for Jira app integration list.


String. Optional.

This is the URL to the hosted git service used on the project.

For example, you might host your repository on GitHub, Beanstalk or your own server.

Example URL: https://api.github.com


Boolean.  Optional.

Set the repository status to updated (enabled) or disabled. If left blank, the default value for this field is false.


Boolean. Optional.

Enables or disables commit notification emails for this repository.


Integer. Optional.

Set the desired value in minutes, as to when commit notifications will be sent. Commit notifications will be e-mailed if the age of the commit is less than or equal to this value.


String. Optional.

The type of integration. Available values are the following:

  • GITHUB - integration with Github.com

  • GITHUB_SERVER - integration with GitHub Enterprise

  • GITLAB - integration with GitLab.com

  • GITLAB_SERVER - integration with GitLab Server (CE/EE) (APIv4)

  • GITLAB_SERVER_LEGACY - integration with GitLab Server (CE/EE) Legacy (APIv3)

  • FILESPACE - integration for a tracked folder

  • AZURE_DEVOPS - integration with Azure DevOps Repos

  • VSTS - integration with Visual Studio Team Services (VSTS)

  • AZURE - integration with Azure DevOps Server

  • TFS_SERVER - integration with Team Foundation Server (TFS)

  • AWS - integration with AWS CodeCommit

  • GERRIT - integration with Gerrit Code Review


String. Optional.

Set as username for the git host. Leave blank if 2FA is enabled.


String. Optional.

Set as password for the git host. Leave blank if 2FA is enabled. Otherwise, fill this in if password has changed.


String. Optional.

This field accepts personal access token from supported git hosts. Fill this in if 2FA is enabled for the git host and if the PAT has changed.


Boolean.  Optional.

The default setting is false.

The SSL Verify setting is set to Enabled by default. If set to disabled, the Git Integration for Jira app will ignore verification of SSL certificates when connecting to a git server.

This setting can also be accessed via Manage Git repositories ➜ 
Actions ➜ Edit repository settings.


String. Optional.

The integration will use the relative REST API path starting with "/" to retrieve the list of tracked repositories. For more information, see Working with Custom API path.


String. Optional.

It is a JMESPath filter expression . The expression will be used to filter API results such as repository names, etc. For more information, see Working with JMESPath filters.


String. Optional.

Specify the specific collection to connect. It is used for Microsoft integrations only.


String. Optional.

Specify AWS region; where CodeCommit repositories are located. The list of regions with their names can be found here.

Supported regions:

  • us-east-1

  • us-east-2

  • us-west-1

  • us-west-2

  • ap-south-1

  • ap-northeast-2

  • ap-southeast-1

  • ap-southeast-2

  • ap-northeast-1

  • ca-central-1

  • eu-central-1

  • eu-west-1

  • eu-west-2

  • eu-west-3

  • eu-north-1

  • me-south-1

  • sa-east-1


Boolean. Optional.

Setting this parameter to true will require users to specify their own PAT for branch and pull/merge request management.


Boolean.  Optional.

Enables or disables the Repository Browser feature for this repository. The default value for this setting is enabled.

Users must have the View Development Tools project permission in order to use this feature.  Consult your Jira System Administrator on permissions.

For more information, see section, Repository Browser.


Boolean.  Optional.

This setting is enabled by default. Enables/disables smart commits processing for this repository or tracked folder. The default value for this field is true.


Boolean.  Optional.

If set to true, the projectMappingIds parameter is ignored. Otherwise, the projectMappingIds parameter value(s) are applied.


Boolean.  Optional.

When enabled, this setting allows Jira users with the View Development Tools and correct Jira/Git Integration for Jira app permissions to view the commit and file diffs inside Jira.


Boolean. Optional.

This setting turns on the memory cache which is used when list of commits are displayed. Set to true if revision indexing will index and link to any mentioned issue keys in the revision history or not (false).


String.  Optional.

Displays all tags for the specific issue, if left blank. Otherwise, set the tags matching pattern to display tags on issue pages that match the specified regular expression pattern.

For more information, see example in Show tags.


Long [ ].  Array.  Optional.

These are numeric projects IDs associated with the repository. When you create a new repository and set the field gitViewerEnabled to true, at least one project must be associated with it.

Example: “projectMappingIds”: [10000.10001]


Boolean. Optional.

When the trustFolderStat setting is set to false, the .git/objects/pack folder will be always scanned to check for new pack files. If set to true, the last-modified attribute of the folder will be used to check the folder for modifications.

The default value for Jira Server is true.

If your repository or JIRA HOME is stored on a network share, it is highly recommended to set this setting to false.

The trustFolderStat setting can be configured for each repository in the integration.


Boolean. Optional.
This is a reference to refs/notes/* used for fetching. The default value for this field is false.

Git notes are not shown…

  • when refs/notes are disabled on connecting a repository;

  • when a new note comes when refs/notes is disabled.


Boolean. Optional.
This is a reference to refs/changes/* used for fetching. The default value for this field is false.


String. Optional.
This is a user-defined list of references used for fetching. It is a comma-separated list with the format: +refs/refname1/*:refs/refname1/*, refs/refname2/*:refs/refname2/*, ...


Updates the recent changes of the parameters for the specified integration.

Example 1:


Request body (JSON) example:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 { "displayName": "MY GITLAB", "origin": "https://api.gitlab.com", "disabled": false, "sendCommitEmails": true, "maxMinsToCommitEmail": 1441, "global": true, "revisionIndexing": true, "gitViewerEnabled": true, "disableSslVerification": false, "smartCommitsEnabled": true, "requireUserPat": false, "projectMappingIds": [], "integrationType": "GITLAB", "sourcesDiffViewEnabled": true, "refSpecNotes": true, "refSpecChanges": false, "trustFolderStat": true } Response: { "success": "true", "integration": { "id": 1, "displayName": "MY GITLAB", "origin": "https://gitlab.com", "disabled": false, "sendCommitEmails": true, "maxMinsToCommitEmail": 1441, "global": true, "initDate": 1626070678087, "lastIndexedDate": 1626070716016, "revisionIndexing": true, "gitViewerEnabled": true, "disableSslVerification": false, "smartCommitsEnabled": true, "requireUserPat": false, "projectMappingIds": [], "integrationType": "GITLAB", "sourcesDiffViewEnabled": true, "refSpecNotes": true, "refSpecChanges": false, "trustFolderStat": true } }

Example 2: Restrict an integration to project(s)


Request body (JSON) example:

1 2 3 4 5 6 7 8 9 10 11 { "id": 1, "pat": "ehvgliy0k665yfms9plf47wj7a2s63th", "gitViewerEnabled": true, "smartCommitsEnabled": true, "global": false, "projectMappingIds": [ 10000 ], } // The endpoint does not accept the "projectMappingIds" list when "global" is set to 'true'.


1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 { "success": "true", "integration": { "id": 1, "displayName": "MY GITLAB", "origin": "https://gitlab.com", "disabled": false, "sendCommitEmails": true, "maxMinsToCommitEmail": 1441, "global": true, "initDate": 1626070678087, "lastIndexedDate": 1626070716016, "revisionIndexing": true, "gitViewerEnabled": true, "disableSslVerification": false, "smartCommitsEnabled": true, "requireUserPat": false, "projectMappingIds": [], "integrationType": "GITLAB", "sourcesDiffViewEnabled": true, "refSpecNotes": true, "refSpecChanges": false, "trustFolderStat": true } }