These APIs are available to Atlassian Connect apps. To use these APIs you must have the jiraRemoteLinkInfoProvider module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/remote-link/.

These APIs are available to Forge apps with the devops:remoteLinkInfoProvider module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-remote-link-info/.

Operations

POST/rest/remotelinks/1.0/bulk DEL/rest/remotelinks/1.0/bulkByProperties GET/rest/remotelinks/1.0/remotelink/{remoteLinkId}DEL/rest/remotelinks/1.0/remotelink/{remoteLinkId}

POST

Submit Remote Link data

Update / insert Remote Link data.

Remote Links are identified by their ID, existing Remote Link data for the same ID will be replaced if it exists and the updateSequenceId of existing data is less than the incoming data.

Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getRemoteLinkById operation can be used to confirm that data has been stored successfully (if needed).

In the case of multiple Remote Links being submitted in one request, each is validated individually prior to submission. Details of which Remote LInk failed submission (if any) are available in the response object.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

write:remote-link-info:jira

Connect app scope required: WRITE

Request

Header parameters

Authorization

string

Required

Request bodyapplication/json

Remote Links data to submit.

properties

Properties

remoteLinks

array<RemoteLinkData>

Required

providerMetadata

ProviderMetadata

Responses

Submission accepted. Each submitted Remote Link that is of a valid format will be eventually available in Jira.

Details of which Remote Links were submitted and which failed submission (due to data format problems etc.) are available in the response object.

application/json

object

The result of a successful submitRemoteLinks request.

POST/rest/remotelinks/1.0/bulk

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";

var bodyData = `{
  "properties": {
    "accountId": "account-234",
    "projectId": "project-123"
  },
  "remoteLinks": [
    {
      "schemaVersion": "1.0",
      "id": "111-222-333",
      "updateSequenceNumber": 1523494301448,
      "displayName": "Remote Link #42",
      "url": "<string>",
      "type": "security",
      "description": "Remote Link #42 with more information in this description",
      "lastUpdated": "2018-01-20T23:27:25.000Z",
      "associations": [
        {
          "associationType": "issueIdOrKeys",
          "values": [
            "ABC-123",
            "ABC-456"
          ]
        }
      ],
      "status": {
        "appearance": "inprogress",
        "label": "ANOMALOUS"
      },
      "actionIds": [
        "action-111-222-333",
        "action-444-555-666"
      ],
      "attributeMap": {}
    }
  ],
  "providerMetadata": {
    "product": "Opsgenie 6.10.2"
  }
}`;

const response = await requestJira(`/rest/remotelinks/1.0/bulk`, {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

202Response

{
  "acceptedRemoteLinks": [
    "111-222-333",
    "444-555-666"
  ],
  "rejectedRemoteLinks": {},
  "unknownAssociations": [
    {
      "associationType": "issueIdOrKeys",
      "values": [
        "ABC-123",
        "ABC-456"
      ]
    }
  ]
}

DEL

Delete Remote Links by Property

Bulk delete all Remote Links data that match the given request.

One or more query params must be supplied to specify Properties to delete by. Optional param _updateSequenceNumber is no longer supported. If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).

See the documentation for the submitRemoteLinks operation for more details.

e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345

Deletion is performed asynchronously. The getRemoteLinkById operation can be used to confirm that data has been deleted successfully (if needed).

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

delete:remote-link-info:jira

Connect app scope required: DELETE

Request

Query parameters

_updateSequenceNumber

integer

params

object

Header parameters

Authorization

string

Required

Responses

Delete accepted. Data will eventually be removed from Jira.

DEL/rest/remotelinks/1.0/bulkByProperties

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";

const response = await requestJira(`/rest/remotelinks/1.0/bulkByProperties`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

GET

Get a Remote Link by ID

Retrieve the currently stored Remote Link data for the given ID. The result will be what is currently stored, ignoring any pending updates or deletes.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

read:remote-link-info:jira

Connect app scope required: READ

Request

Path parameters

remoteLinkId

string

Required

Header parameters

Authorization

string

Required

Responses

The Remote Link data currently stored for the given ID.

application/json

RemoteLinkData

Data related to a single Remote Link.

GET/rest/remotelinks/1.0/remotelink/{remoteLinkId}

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";

const response = await requestJira(`/rest/remotelinks/1.0/remotelink/{remoteLinkId}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

{
  "schemaVersion": "1.0",
  "id": "111-222-333",
  "updateSequenceNumber": 1523494301448,
  "displayName": "Remote Link #42",
  "url": "<string>",
  "type": "security",
  "description": "Remote Link #42 with more information in this description",
  "lastUpdated": "2018-01-20T23:27:25.000Z",
  "associations": [
    {
      "associationType": "issueIdOrKeys",
      "values": [
        "ABC-123",
        "ABC-456"
      ]
    }
  ],
  "status": {
    "appearance": "inprogress",
    "label": "ANOMALOUS"
  },
  "actionIds": [
    "action-111-222-333",
    "action-444-555-666"
  ],
  "attributeMap": {}
}

DEL

Delete a Remote Link by ID

Delete the Remote Link data currently stored for the given ID.

Deletion is performed asynchronously. The getRemoteLinkById operation can be used to confirm that data has been deleted successfully (if needed).

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

delete:remote-link-info:jira

Connect app scope required: DELETE

Request

Path parameters

remoteLinkId

string

Required

Query parameters

_updateSequenceNumber

integer

Header parameters

Authorization

string

Required

Responses

Delete has been accepted. Data will eventually be removed from Jira if it exists.

DEL/rest/remotelinks/1.0/remotelink/{remoteLinkId}

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import { requestJira } from "@forge/bridge";

const response = await requestJira(`/rest/remotelinks/1.0/remotelink/{remoteLinkId}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());