Git Integration for Jira Self-Managed (Data Center/Server) Documentation

Contact Support
GitKraken Status  

Remove Integration API

Deletes the existing integration from the Git Integration for Jira app repository configuration.

Only Jira admins can perform the Remove Integration API call.

 

url

/rest/gitplugin/1.0/integration/{integrationId}

method

DELETE

Parameters

Field Description
integrationId Integer. Required.

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

deleteFiles Boolean. Optional.

Default value is false. Indicates whether the integration folder is also deleted from the Jira server. If set to true, the repository folder is deleted from the Jira server. If set to false, the unused cloned repositories of an integration will remain in jira/home/data/git-plugin folder.

response Deletes the integration from the Git Integration for Jira app repository configuration. If the deleteFiles parameter is set to true, the folders of all the repositories of the integration are also deleted from the Jira instance.
format http://jira.yourorg.com/rest/gitplugin/1.0/integration/[integrationId]?deleteFiles=true

 

Examples

Example 1:

http://jira.yourorg.com/rest/gitplugin/1.0/integration/154?deleteFiles=true

Response:
{
  "success": true
}

Example 2:

http://jira.yourorg.com/rest/gitplugin/1.0/integration/5?deleteFiles=true

Response:
{
  "success": false,
  "error": "Repository with id=5 does not exist",
  "advice": "Please try again with an existing repository id."
}

 

Integration REST APIs

Add New Integration

Add New Integration Type API (examples)

Update Existing Integration

Remove Integration (this page)

Retrieve an Integration

Retrieve Integration List

Have feedback about this article? Did we miss something? Let us know!
On this page