Developer
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Get support
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Get support
Sign in
Platform
App migration platform / Reference / Forge REST API

Forge Resource

Postman Collection
OpenAPI

Forge API endpoint

Operations
POST/app/migration/forge/v1/message/{transferId}/statusPOST/app/migration/forge/v1/mapping/{transferId}/findPOST/app/migration/forge/v1/log/{transferId}GET/app/migration/forge/v1/mapping/{transferId}/pageGET/app/migration/forge/v1/data/{transferId}/allGET/app/migration/forge/v1/data/{fileKey}GET/app/migration/forge/v1/data/{fileKey}/payloadGET/app/migration/forge/v1/container/{transferId}/page
POST

Update message status

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Request bodyapplication/json

status

string

messageIds

array<string>

Responses

OK

POST/app/migration/forge/v1/message/{transferId}/status
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/message/{transferId}/status' \ --header 'Content-Type: application/json' \ --data '{ "status": "SUCCESS", "messageIds": [ "<string>" ] }'
POST

Find mappings by namespace

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Query parameters

namespace

string

Required

Request bodyapplication/json

array<string>

Unique items: true

Responses

OK

*/*

object
POST/app/migration/forge/v1/mapping/{transferId}/find
1 2 3 4 5 6 7 curl --request POST \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/mapping/{transferId}/find?namespace={namespace}' \ --header 'Accept: */*' \ --header 'Content-Type: application/json' \ --data '[ "<string>" ]'
POST

Add log message from the Forge App

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Request bodyapplication/json

message

string

Responses

OK

POST/app/migration/forge/v1/log/{transferId}
1 2 3 4 5 6 curl --request POST \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/log/{transferId}' \ --header 'Content-Type: application/json' \ --data '{ "message": "<string>" }'
GET

Returns paginated mappings for a given namespace

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Query parameters

namespace

string

Required
lastEntity

string

pageSize

integer

Responses

OK

*/*

MigrationMappingDto
GET/app/migration/forge/v1/mapping/{transferId}/page
1 2 3 curl --request GET \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/mapping/{transferId}/page?namespace={namespace}' \ --header 'Accept: */*'
GET

Returns all uploaded file keys for a transfer Id

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Responses

OK

*/*

array<ForgeFileMappingDto>

Unique items: true
GET/app/migration/forge/v1/data/{transferId}/all
1 2 3 curl --request GET \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/data/{transferId}/all' \ --header 'Accept: */*'
GET

Returns an object containing a signed url to retrieve app data

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

fileKey

string

Required

Responses

OK

*/*

object
GET/app/migration/forge/v1/data/{fileKey}
1 2 3 curl --request GET \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/data/{fileKey}' \ --header 'Accept: */*'
GET

Returns an object containing a signed url to retrieve app data

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

fileKey

string

Required

Responses

OK

application/octet-stream

string

GET/app/migration/forge/v1/data/{fileKey}/payload
1 2 3 curl --request GET \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/data/{fileKey}/payload' \ --header 'Accept: application/octet-stream'
GET

Returns containers for a given transferId and container Type

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

transferId

string

Required

Query parameters

containerType

string

Required
lastEntity

string

pageSize

integer

Responses

OK

*/*

ContainerByPageResponse
GET/app/migration/forge/v1/container/{transferId}/page
1 2 3 curl --request GET \ --url 'https://{cloud-site-name}.atlassian.net/rest/api/latest/app/migration/forge/v1/container/{transferId}/page?containerType={containerType}' \ --header 'Accept: */*'

Rate this page: