Automatic Jira cloud backup using API token with scopes

[Thushan Nirasha]

Automatic Jira cloud backup using an Unscopes API token and basic authentication works fine with the following URL: {{baseUrl}}/rest/backup/1/export/runbackup.

But with a scoped API token and basic authentication, it does not work with the new URL structure for the scoped API token - https://api.atlassian.com/ex/jira/{cloudid}/{api}. And doesn’t know how to construct the URL to initiate backup with the new URL structure because there is no documented endpoint for that.

[Akash Singh]

@Thushan Nirasha Welcome to Atlassian Community!

The Jira backup API endpoint (/rest/backup/1/export/runbackup) is not part of Atlassian’s officially supported APIs, and currently, none of the classic scopes grant permission to perform this operation. For now, I recommend continuing to use this API with an encrypted unscoped token.

Atlassian has mentioned plans to introduce a new automatic backup feature, but the feature is currently in EAP. You can read more about it here.

[Thushan Nirasha]

Hey @Akash Singh 

Thanks for answering.

Unfortunately, I cannot use the unscoped api token because that has all the admin privileges, and also this will be deprecated very soon. I'm looking for a way to do this using a scoped token with the minimum access permission.

[Aaron Williams]

Hey @Thushan Nirasha 

You need to reconstruct the new URL using {cloudid} instead of your instances name. 

An easy way to find the cloud ID is by going to admin.atlassian.com and picking your instance. The ID will then be in the URL. 

I hope this helps

Thanks

Aaron. 

[Thushan Nirasha]

Hey @Aaron Williams 

Thanks for answering.

I obtain the cloud ID by visiting admin.atlassian.com. Then I construct the URL like this - 

https://api.atlassian.com/ex/jira/{cloudid}/rest/backup/1/export/runbackup. However, my response is 'Not Found' with 'FAILURE_CLIENT_TCS'. 

Then, I obtain the cloud ID by following the community article at this URL: https://{instance-name}.atlassian.net/_edge/tenant_info. However, those two cloud IDs are also different. When I construct the URL using this cloud ID, my response is 

'Unauthorized' with 'FAILURE_CLIENT_SCOPE_CHECK'. 

I created my API token(with scopes) by giving all the classic scopes as well.