Last updated Oct 24, 2024

Connect your cloud site to the on-premises instance

Before you create a migration task, connect or reconnect to your cloud site. This step is needed to authenticate your migration plugin with your cloud site. You can connect your cloud site to your on-premises instance using either the CMA UI or an API.

Using migration assistant UI

Connect or reconnect to your cloud site using the Jira or Confluence migration assistant. Learn how to renew your cloud token

Using APIs

APIs are supported since the following CMA versions:

  • JCMA: 1.12.5
  • CCMA: 3.10.8

1. Create auth token

The API creates an auth token that's valid for 5 minutes.

2. Save token

The API takes the token returned from the create auth token endpoint and saves it to your instance using the migration assistant. Using an expired token will cause the operation to fail.

Endpoint

POST {server_url}/rest/migration/latest/cloud/save/token

Request body
1
2
{
    "cloudUrl": "{cloud_site_url}",
    "token": "{auth_token}"
}

Where:

  • {server_url} is the URL of your Jira or Confluence on-premises instance
  • {cloud_site_url} is the URL of the cloud site to which you are migrating, for example https://user.atlassian.net/
  • {auth_token} is the token returned from the create auth token API
  • Headers: You need to provide an additional header Content-Type with value application/json in the request.
  • On-premises authorization

Response (application/json)

Token Saved - 200:
1
2
{
  "cloudUrl": "{cloud_site_url}",
  "message": "Token saved successfully."
}
Invalid request or Internal Server Error - 500:
1
2
Exception in saving token.

Troubleshooting errors: In case of an error, check whether the auth token that you are passing isn't expired. Also check troubleshooting page.

Rate this page: