APIs for updating links after Data Center to Cloud or Cloud to Cloud migrations
Updates links that go to a a destination product (Jira, Confluence) that was migrated from Data Center or a different Cloud site.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
boolean
boolean
A link update has been scheduled. You should receive an ID that you can use to check the status.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl --request POST \
--url 'https://api.atlassian.com/links/v1/{siteId}/jobs/cma' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"product": "<string>",
"productURL": "<string>",
"destinationURL": "<string>",
"migratedFrom": "<string>",
"migratedFromOverride": "<string>",
"recreateAsRemote": true,
"createBackup": true
}'1
2
3
{
"uuid": "<string>"
}Returns the status of a link update by ID.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccessful operation
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/links/v1/{siteId}/jobs/status/{jobId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"id": "<string>",
"status": "PENDING",
"error": {
"error": "UNAUTHENTICATED_ERROR",
"description": "<string>",
"details": "<string>",
"productUri": "<string>"
},
"linksMigrationResults": {},
"startTimeEpoch": 1701432850,
"endTimeEpoch": 1701432850,
"jobRequestDetails": {
"product": "JIRA",
"productURL": "<string>",
"destinationURL": "<string>",
"migratedFrom": "<string>",
"createBackup": true
}
}Returns the statuses of all link updates performed for a given product.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredSuccessful operation
array<JobStatusDTO>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/links/v1/{siteId}/jobs/status?product={product}&productURL={productURL}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
[
{
"id": "<string>",
"status": "PENDING",
"error": {
"error": "UNAUTHENTICATED_ERROR",
"description": "<string>",
"details": "<string>",
"productUri": "<string>"
},
"linksMigrationResults": {},
"startTimeEpoch": 1701432850,
"endTimeEpoch": 1701432850,
"jobRequestDetails": {
"product": "JIRA",
"productURL": "<string>",
"destinationURL": "<string>",
"migratedFrom": "<string>",
"createBackup": true
}
}
]Returns the list of all products in an organization. You can use it to help you find products that might have links to update.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredSuccessful operation
array<ProductDTO>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/links/v1/{siteId}/jobs/products/{orgId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[
{
"siteId": "<string>",
"siteURL": "<string>",
"lastMigrationTimeEpoch": 1701432850,
"lastLinksUpdateTimeEpoch": 1701432850,
"lastLinksUpdateStatus": "PENDING",
"scopes": [
{
"migratedFrom": "<string>",
"destinationURL": "<string>",
"productFamily": "JIRA"
}
],
"productFamily": "JIRA",
"sandbox": true,
"productKey": "<string>",
"productName": "<string>"
}
]Exports the audit log that shows every successful link modification for a given product from the last 29 days.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredThe audit log is being generated. When completed, you'll receive an email with the download link.
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'https://api.atlassian.com/links/v1/{siteId}/report/links' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"product": "<string>",
"productURL": "<string>"
}'1
2
3
{
"result": "<string>"
}Exports the history report that shows the summary of all link updates for a given product and their summarized results.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredThe history report is being generated. When completed, you'll receive an email with the download link.
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'https://api.atlassian.com/links/v1/{siteId}/report/jobs' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"product": "<string>",
"productURL": "<string>"
}'1
2
3
{
"result": "<string>"
}Rate this page: