Atlassian Marketplace Developer

Atlassian Marketplace Developer

Rate this page:

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

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

Responses

Successful GET response

Content typeValue
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/Data center 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

A compatible version of app's Server/DC version w.r.t. cloud migration assistant

Example

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

Responses

Successfully created

Content typeValue
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 typeValue
application/json-patch+json

Array<AppMigrationPatchDocumentation>

Example

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

Responses

Successful

Content typeValue
application/json

AppMigrationInformation

Rate this page: