The Atlassian Marketplace REST API

Migrations

Information about app migration compatibility

Get migration info

GET /rest/2/addons/{addonKey}/migration

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 Required

string

The unique identifier for this app

Example

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'

Responses

200

404

Successful GET response

Content type	Value
application/json	AppMigrationInformation

Create migration info

PUT /rest/2/addons/{addonKey}/migration

Create app migration information for consumption. All fields are optional

Request

Path parameters

addonKey Required

string

The unique identifier for this app

Body parameters

cloudAddonKey

string

Cloud specific addonKey, for when an equivalent Cloud version of an existing Server/DC app is hosted in its own separate Marketplace listing

cloudVersionAvailability

string

Description of cloud version

Valid values: NATIVE, PUBLIC, PRIVATE

cloudVersionDevelopmentRoadmap

string

URL to page documenting cloud version development roadmap

featureDifferenceDocumentation

string

URL to page documenting feature difference documentation

migrationDocumentation

string

URL to page documenting Server/DC to cloud migration documentation

cloudMigrationAssistantCompatibility

string

The Server/DC app's minimum version that is compatible with the Cloud Migration Assistant

Example

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"
}'

Responses

200

400

404

Successfully created

Content type	Value
application/json	AppMigrationInformation

Update migration info

PATCH /rest/2/addons/{addonKey}/migration

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

Request

Path parameters

addonKey Required

string

The unique identifier for this app

Body parameters

Content type	Value
application/json-patch+json	Array<AppMigrationPatchDocumentation>

Example

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'

Responses

200

400

404

Successful

Content type	Value
application/json	AppMigrationInformation