Platform

App migration platform / Reference / REST API

Transfer retrieval API

Postman Collection

OpenAPI

Provides endpoints to retrieve active transfers and its migration details

Operations

GET/transfer/recent GET/container/{transferId}/page

GET

Get list of active transfers

Returns a list of latest active transfers (upto 100) with migration details

Request

This request has no parameters.

Responses

application/json

array<TransferMetadata>

GET/transfer/recent

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/transfer/recent' \
  --header 'Accept: application/json'

200Response

[
  {
    "migrationDetails": {
      "cloudUrl": "https://www.destination-cloudsite.com",
      "confluenceClientKey": "847e2ce1-34e0-4b3d-a487-344f3d0b2909",
      "createdAt": 1702530783417,
      "jiraClientKey": "fbc7b56e-82fd-4c43-a73b-854fa668ec49",
      "migrationId": "fd2b0ea1-3e68-464e-86d7-8f34a3441c2f",
      "migrationScopeId": "0bba5d1d-7b51-4e85-a6e2-31745aa65849",
      "name": "My test migration"
    },
    "transferId": "2e170ff3-6aa6-4969-a08a-e60119ef2db3",
    "status": "IN_PROGRESS"
  }
]

GET

Get containers in pages

Returns containers for a given container type

Request

Path parameters

transferId

string

Required

Query parameters

containerType

string

Required

lastEntity

string

pageSize

integer

Responses

application/json

ContainerFetchResponse

GET/container/{transferId}/page

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/container/{transferId}/page?containerType={containerType}' \
  --header 'Accept: application/json'

200Response

{
  "containers": {},
  "meta": {
    "hasNext": true,
    "lastEntity": "<string>",
    "pageSize": 2154
  }
}