Notification API
    Status API
    Mapping API
    App data retrieval API
    Transfer retrieval API
    Feedback channel API

    Rate this page:

    Status API

    Provides a status of active transfer to the server product. No further update could be made to the transfer, once it is updated with status INCOMPLETE, FAILED, SUCCESS. This means, all the subsequent REST calls using this transferId will return 403 response code.

    Disclaimer: Atlassian Connect Resource. Replace the product-specific-path with the corresponding product API i.e.,

    • your-site.atlassian.net/wiki/rest/atlassian-connect/1/migration/ for Confluence
    • your-site.atlassian.net/rest/atlassian-connect/1/migration/ for Jira

    Send migration progress

    POST /rest/atlassian-connect/1/migration/progress/{transferId}

    Update or create transfer progress and status for a given transferId

    Request

    Path parameters
    transferId Required

    string

    transferId

    Format: uuid
    Body parameters
    status Required

    string

    Used to update status for given transfer id

    Valid values: IN_PROGRESS, SUCCESS, FAILED, INCOMPLETE

    percent

    integer

    Used to update progress percentage for a given transfer. If the percentage value that is passed is lower than the value in the previous request, the percentage update will be ignored.

    Minimum: 0, Maximum: 100, Format: int32
    message Required

    string

    Used to add progress message for given transfer. The maximum length of a status message is 1000, and anything above this limit is truncated.

    Example

    1
2
3
4
5
6
7
8
    curl --request POST \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/progress/{transferId}' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "IN_PROGRESS",
  "percent": 90,
  "message": "<string>"
}'

    Responses

    OK

    A schema has not been defined for this response code.

    Rate this page: