Platform

Atlassian Marketplace / Reference / Marketplace REST API (v2)

Migrations

Postman Collection

OpenAPI

Information about app migration compatibility

Operations

GET/addons/{addonKey}/migration PUT/addons/{addonKey}/migration PATCH/addons/{addonKey}/migration

GET

Get migration info

Get migration info about the Server/DC version for this app. All fields except addonName, addonKey and vendorId are optional and may not exist

Request

Path parameters

addonKey

string

Required

Responses

Successful GET response

application/json

AppMigrationInformation

GET/addons/{addonKey}/migration

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/migration' \
  --header 'Accept: application/json'

200Response

{
  "addonName": "Insight - Asset Management",
  "vendorId": 85,
  "addonKey": "com.riadalabs.jira.plugins.insight",
  "cloudAddonKey": "<string>",
  "cloudVersionAvailability": "NATIVE",
  "cloudVersionDevelopmentRoadmap": "<string>",
  "featureDifferenceDocumentation": "<string>",
  "migrationDocumentation": "<string>",
  "cloudMigrationAssistantCompatibility": "8.6.5",
  "isDualLicenseOptedIn": true,
  "migrationRoadmapTicketLink": "<string>",
  "migrationPath": "UNKNOWN",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "6.5.0",
      "end": "8.6.5"
    }
  ]
}

PUT

Create migration info

Create app migration information for consumption. All fields are optional

Request

Path parameters

addonKey

string

Required

Request bodyapplication/json

cloudAddonKey

string

cloudVersionAvailability

string

cloudVersionDevelopmentRoadmap

string

featureDifferenceDocumentation

string

migrationDocumentation

string

cloudMigrationAssistantCompatibility

string

isDualLicenseOptedIn

boolean

migrationRoadmapTicketLink

string

migrationPath

string

cloudMigrationAssistantCompatibilityRanges

array<cloudMigrationAssistantCompatibilityRange>

Responses

Successfully created

application/json

AppMigrationInformation

PUT/addons/{addonKey}/migration

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/migration' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "cloudAddonKey": "<string>",
  "cloudVersionAvailability": "NATIVE",
  "cloudVersionDevelopmentRoadmap": "<string>",
  "featureDifferenceDocumentation": "<string>",
  "migrationDocumentation": "<string>",
  "cloudMigrationAssistantCompatibility": "8.6.5",
  "isDualLicenseOptedIn": true,
  "migrationRoadmapTicketLink": "<string>",
  "migrationPath": "UNKNOWN",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "6.5.0",
      "end": "8.6.5"
    }
  ]
}'

200Response

{
  "addonName": "Insight - Asset Management",
  "vendorId": 85,
  "addonKey": "com.riadalabs.jira.plugins.insight",
  "cloudAddonKey": "<string>",
  "cloudVersionAvailability": "NATIVE",
  "cloudVersionDevelopmentRoadmap": "<string>",
  "featureDifferenceDocumentation": "<string>",
  "migrationDocumentation": "<string>",
  "cloudMigrationAssistantCompatibility": "8.6.5",
  "isDualLicenseOptedIn": true,
  "migrationRoadmapTicketLink": "<string>",
  "migrationPath": "UNKNOWN",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "6.5.0",
      "end": "8.6.5"
    }
  ]
}

PATCH

Update migration info

Update migration information for this app. All fields except addonName, addonKey and vendorId are optional and may not exist

Request

Path parameters

addonKey

string

Required

Request bodyapplication/json-patch+json

array<AppMigrationPatchDocumentation>

string

path

string

value

string

Responses

Successful

application/json

AppMigrationInformation

PATCH/addons/{addonKey}/migration

curl

Node.js

Java

Python

PHP

curl --request PATCH \
  --url 'https://marketplace.atlassian.com/rest/2/addons/{addonKey}/migration' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "addonName": "Insight - Asset Management",
  "vendorId": 85,
  "addonKey": "com.riadalabs.jira.plugins.insight",
  "cloudAddonKey": "<string>",
  "cloudVersionAvailability": "NATIVE",
  "cloudVersionDevelopmentRoadmap": "<string>",
  "featureDifferenceDocumentation": "<string>",
  "migrationDocumentation": "<string>",
  "cloudMigrationAssistantCompatibility": "8.6.5",
  "isDualLicenseOptedIn": true,
  "migrationRoadmapTicketLink": "<string>",
  "migrationPath": "UNKNOWN",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "6.5.0",
      "end": "8.6.5"
    }
  ]
}