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

    Migration job

    Postman Collection
    OpenAPI

    A migration job is a wrapper object describing a migration. This description includes a flow, such as jira-onpremises-to-cloud, the name of your migration, source, destination, and scope. Use this resource to create new jobs or get existing ones.

    POST

    Create migration job

    Use this resource to create new migration jobs. Creating a job returns a jobId, which you can then use to execute pre-migration checks as well as migrations.
    Rate limit: 5 requests per minute.

    Request

    Request bodyapplication/json

    flow

    string

    Required
    name

    string

    source

    oneOf [ServerSite, CloudSite]

    Required
    destination

    oneOf [ServerSite, CloudSite]

    Required
    scope

    oneOf [ConfluenceOnpremisesToCloudScope, JiraOnpremisesToCloudScope]

    Required

    Responses

    OK

    application/json

    CreateJobResponse
    POST/migrations/public/v1/jobs
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 curl --request POST \ --url 'https://api.atlassian.com/migrations/public/v1/jobs' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "flow": "jira-onpremises-to-cloud", "source": { "serverId": "0123456789" }, "destination": { "url": "https://username.jira-dev.com" }, "scope": { "projects": { "includedKeys": [ "ABC", "DEF", "XYZ" ], "includedData": "all" } } }'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 { "jobId": "0bacecde-372e-4d84-8d79-d66433b8fa45", "jobDefinition": { "flow": "<string>", "name": "<string>", "source": {}, "destination": {}, "scope": { "spaces": { "includedKeys": [ "<string>" ], "includedData": "ALL" }, "usersAndGroups": { "mode": "ALL" }, "apps": { "includedKeys": [ "<string>" ] }, "globalEntities": { "includedTypes": [ "GLOBAL_PAGE_TEMPLATES" ] } } } }
    GET

    Get migration job

    Use this resource to get the details of an existing job.
    Rate limit: 600 requests per minute.

    Request

    Path parameters

    jobId

    string

    Required

    Responses

    default response

    application/json

    any

    GET/migrations/public/v1/jobs/{jobId}
    1 2 curl --request GET \ --url 'https://api.atlassian.com/migrations/public/v1/jobs/{jobId}'
    defaultResponse
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 { "name": "Sample migration", "flow": "jira-onpremises-to-cloud", "source": { "serverId": "0123456789" }, "destination": { "url": "https://username.jira-dev.com" }, "scope": { "projects": { "includedKeys": [], "includedData": "all" }, "usersAndGroups": { "mode": "referenced", "preserveMemberships": "true", "includeUsersInGroups": false, "includeRoleActors": false }, "jsm": { "customers": { "mode": "referenced" } }, "ar": { "mode": "none" }, "apps": { "includedKeys": [] } } }