The App migration platform REST API

Mapping API

Provides endpoints to retrieve mappings

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

Get mappings by keys

POST /rest/atlassian-connect/1/migration/api/connect/v1/mapping/{transferId}/find

Retrieves mappings for a specific namespace filtering by the keys provided on the payload

Request

Path parameters

transferId Required

string

Transfer ID as UUID

Format: uuid

Query parameters

namespace Required

string

Namespace

Body parameters

Content type	Value
application/json	Array<string>

Example

cURL

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/api/connect/v1/mapping/{transferId}/find?namespace={namespace}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

Responses

200

201

401

403

404

Content type	Value
application/json	object

Get mappings in pages

GET /rest/atlassian-connect/1/migration/mapping/{transferId}/page

Returns mappings for a given namespace

Request

Path parameters

transferId Required

string

transferId

Format: uuid

Query parameters

namespace Required

string

namespace

lastEntity

string

lastEntity

pageSize

integer

pageSize

Default: 5000, Minimum: 1, Maximum: 5000

Example

cURL

Node.js

Java

Python

PHP

1
2
3

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

Responses

200

400

401

403

404

Content type	Value
application/json	MigrationMappingDto