• Migration job
    • Migration task
    • Migration task status
    Platform
    Migration API / Reference / REST API

    Migration task

    Postman Collection
    OpenAPI

    Use migration task resources to execute migration tasks or run pre-flight checks. Tasks are aggregated under a job.

    GET

    Get migration tasks by job

    Returns all the tasks for the given jobId, sorted in descending order of creation. Response is paginated with 20 entries per page.
    Rate limit: 600 requests per minute.

    Request

    Path parameters

    jobId

    string

    Required

    Query parameters

    cursor

    string

    Responses

    OK

    application/json

    GetAllTaskResponse
    GET/migrations/public/v1/jobs/{jobId}/tasks
    1 2 3 curl --request GET \ --url 'https://api.atlassian.com/migrations/public/v1/jobs/{jobId}/tasks' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "data": [ { "taskId": "<string>", "taskType": "<string>", "createdAt": "<string>", "payload": "<string>" } ], "links": { "next": "<string>", "self": "<string>" } }
    POST

    Create migration task

    Use this API to create new tasks. A task can either be a pre-migration check or a migration. The endpoint returns a taskId, which you can later use to check the status and definition of your tasks.
    Rate limit: 5 requests per minute.

    Request

    Path parameters

    jobId

    string

    Required

    Request bodyapplication/json

    task

    anyOf [ConfluenceOnpremisesToCloudTaskTypes, JiraOnpremisesToCloudTaskTypes]

    Required
    options

    oneOf [ConfluenceOnpremisesToCloudCheckOptions, JiraOnpremisesToCloudCheckOptions, JiraOnpremisesToCloudMigrateOptions]

    Responses

    OK

    application/json

    CreateTaskResponse
    POST/migrations/public/v1/jobs/{jobId}/tasks
    1 2 3 4 5 6 7 curl --request POST \ --url 'https://api.atlassian.com/migrations/public/v1/jobs/{jobId}/tasks' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "task": "check" }'
    200Response
    1 2 3 { "taskId": "0bacecde-372e-4d84-8d79-d66433b8fa45" }
    GET

    Get migration task

    Returns the definition of a specific task within a job. Requires both a jobId and a taskId.
    Rate limit: 600 requests per minute.

    Request

    Path parameters

    jobId

    string

    Required
    taskId

    string

    Required

    Responses

    OK

    application/json

    GetTaskResponse
    GET/migrations/public/v1/jobs/{jobId}/tasks/{taskId}
    1 2 3 curl --request GET \ --url 'https://api.atlassian.com/migrations/public/v1/jobs/{jobId}/tasks/{taskId}' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 { "taskId": "<string>", "taskType": "<string>", "createdAt": "<string>", "payload": "<string>" }