How to remove Application Link (AppLinks) via REST API

Related content

  • No related content found

Still need help?

The Atlassian Community is here for you.

Ask the community

Platform Notice: Data Center - This article applies to Atlassian products on the Data Center platform.

Note that this knowledge base article was created for the Data Center version of the product. Data Center knowledge base articles for non-Data Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

Symptoms

Unable to add add-on via UPM due to the Application Link still remaining after a previous installation or want to programatically remove an Application Link without accessing JIRA UI.

Diagnosis

Each application link is identified via the following REST call.  Run this curl command to identify the Application Links available:

curl -s -X GET -u <user>:<pass> -H "Accept: application/json" <hostname>/rest/applinks/1.0/listApplicationlinks | python -mjson.tool
Expand for sample... 
{
 "list": [
 {
 "appLinkState": "OK",
 "application": {
 "displayUrl": "https://localhost",
 "iconUrl": "http://localhost:8080/s/en_US-jlq2il-418945332/813/3/3.10.4/_/download/resources/com.atlassian.applinks.applinks-plugin:applinks-images/images/types/16jira.png",
 "id": "2841b105-5904-3c0a-9710-1ff26ae88206",
 "isPrimary": true,
 "isSystem": false,
 "link": [
 {
 "href": "http://localhost:8080/rest/applinks/1.0/applicationlink/2841b105-5904-3c0a-9710-1ff26ae88206",
 "rel": "self"
 }
 ],
 "name": "JIRA",
 "rpcUrl": "https://<destination>",
 "typeId": "jira"
 },
 "configuredInboundAuthenticators": [],
 "configuredOutboundAuthenticators": [],
 "entityTypeIdStrings": [
 "jira.project"
 ],
 "hasIncomingAuthenticationProviders": true,
 "hasOutgoingAuthenticationProviders": true,
 "isSystem": false,
 "webItems": [],
 "webPanels": []
 }
 ]
}

Resolution

In this example we will try to remove the JIRA application link with the id from the example above: 2841b105-5904-3c0a-9710-1ff26ae88206

The profile used for the deletion does require 'jira-administrators' permission

curl -X DELETE -u <username>:<password> -H "Accept: application/json" localhost:8080/rest/applinks/1.0/applicationlink/2841b105-5904-3c0a-9710-1ff26ae88206
{"message":"Deleted application with id '2841b105-5904-3c0a-9710-1ff26ae88206'","status-code":200}

A successful deletion will always return a 200 message code.

Reviewing the Application Links in the UI via {JIRA Home}/plugins/servlet/applinks/listApplicationLinks will confirm the removal of the Application Link.

Last modified on Jan 9, 2025

Was this helpful?

Yes
No
Provide feedback about this article

Related content

  • No related content found
Powered by Confluence and Scroll Viewport.