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

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

productId

string

Required

Responses

Successful GET response

application/json

ProductMigrationInformation

GET/rest/3/cloud-migration-compatibility/products/{productId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://api.atlassian.com/marketplace/rest/3/cloud-migration-compatibility/products/{productId}' \
  --header 'Accept: application/json'

200Response

{
  "developerId": "87654321-4321-4321-4321-210987654321",
  "productId": "acd011b1-1111-45bc-902a-247046a11111",
  "addonKey": "com.riadalabs.jira.plugins.insight",
  "addonName": "Insight - Asset Management",
  "cloudAddonKey": "com.riadalabs.jira.plugins.insight",
  "cloudVersionAvailability": "PUBLIC",
  "cloudVersionDevelopmentRoadmap": "https://documentation.mindville.com/display/ICE/Roadmap",
  "featureDifferenceDocumentation": "https://documentation.mindville.com/display/ICE/Feature+Comparison",
  "migrationDocumentation": "https://documentation.mindville.com/display/ICE/Migration+Guide",
  "cloudMigrationAssistantCompatibility": "8.6.5",
  "isDualLicenseOptedIn": true,
  "migrationPath": "AUTOMATED",
  "migrationRoadmapTicketLink": "https://jira.atlassian.com/browse/INSIGHT-1234",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "1.0.0",
      "end": "8.6.5"
    }
  ]
}

PUT

Create migration info by product ID

Create product migration information for consumption. All fields are optional except developerId and addonName.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

productId

string

Required

Request bodyapplication/json

developerId

string

Required

addonName

string

Required

cloudAddonKey

string

cloudVersionAvailability

string

cloudVersionDevelopmentRoadmap

string

featureDifferenceDocumentation

string

migrationDocumentation

string

cloudMigrationAssistantCompatibility

string

isDualLicenseOptedIn

boolean

migrationRoadmapTicketLink

string

Responses

Successfully created

application/json

ProductMigrationInformation

PUT/rest/3/cloud-migration-compatibility/products/{productId}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://api.atlassian.com/marketplace/rest/3/cloud-migration-compatibility/products/{productId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "developerId": "87654321-4321-4321-4321-210987654321",
  "addonName": "Calendar for Jira",
  "cloudAddonKey": "com.doitb.calendar.jira.cloud",
  "cloudVersionAvailability": "PUBLIC",
  "cloudVersionDevelopmentRoadmap": "https://docs.doitb.com/calendar-for-jira/roadmap",
  "featureDifferenceDocumentation": "https://docs.doitb.com/calendar-for-jira/cloud-vs-server",
  "migrationDocumentation": "https://docs.doitb.com/calendar-for-jira/migrating-from-server-to-cloud",
  "cloudMigrationAssistantCompatibility": "4.5.0",
  "migrationPath": "AUTOMATED",
  "isDualLicenseOptedIn": true,
  "migrationRoadmapTicketLink": "https://jira.atlassian.com/browse/CALENDAR-5678",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "4.0.0",
      "end": "4.5.0"
    }
  ]
}'

200Response

{
  "developerId": "87654321-4321-4321-4321-210987654321",
  "productId": "acd011b1-1111-45bc-902a-247046a11111",
  "addonKey": "com.doitb.calendar.jira",
  "addonName": "Calendar for Jira",
  "cloudAddonKey": "com.doitb.calendar.jira.cloud",
  "cloudVersionAvailability": "PUBLIC",
  "cloudVersionDevelopmentRoadmap": "https://docs.doitb.com/calendar-for-jira/roadmap",
  "featureDifferenceDocumentation": "https://docs.doitb.com/calendar-for-jira/cloud-vs-server",
  "migrationDocumentation": "https://docs.doitb.com/calendar-for-jira/migrating-from-server-to-cloud",
  "cloudMigrationAssistantCompatibility": "4.5.0",
  "migrationPath": "AUTOMATED",
  "isDualLicenseOptedIn": true,
  "migrationRoadmapTicketLink": "https://jira.atlassian.com/browse/CALENDAR-5678",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "4.0.0",
      "end": "4.5.0"
    }
  ]
}

PATCH

Update migration info by product ID

Update migration information for this product. All fields except addonName, addonKey, productId and developerId are optional and may not exist.

Common Use Case: Update migration information for an app moving from UNKNOWN to AUTOMATED status. This typically involves setting the migration path, adding compatibility information, and providing documentation links for users.

Use JSON Patch operations to update specific fields. Supported operations are:

replace: Update an existing field value
add: Add a new field or update an existing one
remove: Remove a field (where applicable)

Example Request:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
[
  {
    "op": "replace",
    "path": "/migrationPath",
    "value": "AUTOMATED"
  },
  {
    "op": "add",
    "path": "/cloudMigrationAssistantCompatibility",
    "value": "8.6.5"
  },
  {
    "op": "replace",
    "path": "/cloudVersionAvailability",
    "value": "PUBLIC"
  },
  {
    "op": "add",
    "path": "/migrationDocumentation",
    "value": "https://documentation.mindville.com/display/ICE/Migration+Guide"
  },
  {
    "op": "add",
    "path": "/migrationRoadmapTicketLink",
    "value": "https://jira.atlassian.com/browse/INSIGHT-9999"
  },
  {
    "op": "add",
    "path": "/isDualLicenseOptedIn",
    "value": true
  }
]

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

productId

string

Required

Request bodyapplication/json-patch+json

array<AppMigrationPatchDocumentation>

string

path

string

value

string

Responses

Successful

application/json

ProductMigrationInformation

PATCH/rest/3/cloud-migration-compatibility/products/{productId}

curl

Node.js

Java

Python

PHP

curl --request PATCH \
  --url 'https://api.atlassian.com/marketplace/rest/3/cloud-migration-compatibility/products/{productId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

{
  "developerId": "87654321-4321-4321-4321-210987654321",
  "productId": "acd011b1-1111-45bc-902a-247046a11111",
  "addonKey": "com.riadalabs.jira.plugins.insight",
  "addonName": "Insight - Asset Management",
  "cloudAddonKey": "com.riadalabs.jira.plugins.insight",
  "cloudVersionAvailability": "PUBLIC",
  "cloudVersionDevelopmentRoadmap": "https://documentation.mindville.com/display/ICE/Roadmap",
  "featureDifferenceDocumentation": "https://documentation.mindville.com/display/ICE/Feature+Comparison",
  "migrationDocumentation": "https://documentation.mindville.com/display/ICE/Migration+Guide",
  "cloudMigrationAssistantCompatibility": "8.6.5",
  "isDualLicenseOptedIn": true,
  "migrationPath": "AUTOMATED",
  "migrationRoadmapTicketLink": "https://jira.atlassian.com/browse/INSIGHT-9999",
  "cloudMigrationAssistantCompatibilityRanges": [
    {
      "start": "1.0.0",
      "end": "8.6.5"
    }
  ]
}