Status API

Postman Collection

OpenAPI

Provides endpoints to update the status of the transfer. To learn more, see App migration transfers.

Operations

POST/progress/{transferId}

POST

Send migration progress

Updates migration status for a given transfer ID.

When you implement the listener interface in your server app, your cloud app must use this operation to:

Report progress on your app migration so that admin users can monitor it in the Cloud Migration Assistant.
Settle the transfer at the end of your migration by updating its status to SUCCESS, INCOMPLETE, or FAILED so that admin users know it's finished.

Once a transfer is settled, subsequent requests for that transfer ID return an HTTP 403 error.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Request bodyapplication/json

progressEndpointDto

status

string

Required

percent

integer

message

string

Responses

application/json

ProgressEndpointDto

POST/progress/{transferId}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/progress/{transferId}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "IN_PROGRESS",
  "percent": 90,
  "message": "App data migration is in the last stage. For more info, refer to http://documentation.example.com."
}'

200Response

{
  "status": "IN_PROGRESS",
  "percent": 90,
  "message": "App data migration is in the last stage. For more info, refer to http://documentation.example.com."
}