Performing a data-only backup via REST API

[Pierangelo Repetti]

Hello,

at present, the scripts here

https://bitbucket.org/atlassianlabs/automatic-cloud-backup/src/master/

are all we've got to build an automatic backup procedure for JIRA Cloud. Fine.

How can we change/use the backup-jira-api-token.sh script to perform a data-only backup excluding attachments, avatars, and logos ?

Thank you

Pierangelo

[Dario B · Accepted solution]

Hi @Pierangelo Repetti ,

In order to change the backup script so that it does not  include attachments you have to change line 31 of the backup-jira-api-token.sh script:

BKPMSG=$(curl -s -u ${EMAIL}:${API_TOKEN} -H "Accept: application/json" -H "Content-Type: application/json" --data-binary '{"cbAttachments":"true", "exportToCloud":"true"}' -X POST https://${HOSTNAME}/rest/backup/1/export/runbackup )

Specifically, you have to change the payload sent with the request from:

{"cbAttachments":"true", "exportToCloud":"true"}

To:

{"cbAttachments":"false", "exportToCloud":"true"}

Please test this and let me know if it works.

Also, I will try to modify the script so that it is possible to configure at the top of it whether the backup is for Server or Cloud and whether to include the attachments.

Cheers,
Dario

[Pierangelo Repetti]

I applied the change you suggested. I think it is working because the zip file created by the script is much much smaller than the full backup I created from JIRA administration.

I'll accept your answer.

A parameter in the configuration section would be great.

Thank you very much.

[Dario B]

You are very welcome @Pierangelo Repetti ,

As soon as I will have some time I will try to add those properties to the top of the script.

Ciao,
Dario

[Jagadeesh_M]

hi @Dario B 

Will "cbAttachment":"true" cover also Avatars and logos?.

Regards

[Dario B]

Hi @Pierangelo Repetti ,

Just FYI, I have committed the updated Bash scripts to backup Jira and Confluence Cloud so that you can choose:

• Jira: to generate a backup for Cloud or Server and whether or not to include attachments
• Confluence: whether or not to include attachments.

Please test them and let me know if they work.

Cheers,
Dario

[Pierangelo Repetti]

Hello Dario,

I tested the Confluence script, it is working.

Thanks for your work.

Pierangelo

[Dario B]

You are very welcome @Pierangelo Repetti ! :) 

[Quang Pham]

Please send me a link to Jira: to generate a backup for Cloud 

[Dario B]

Hi @Quang Pham ,

I am not sure I understand what you are asking for, since the endpoints to start a backup are listed in the scripts you can find in the repository mentioned in the very first message of this thread:

• https://bitbucket.org/atlassianlabs/automatic-cloud-backup/src/master/

In case this won't help, kindly provide more details on what you are trying to do/achieve

Cheers,
Dario

[Ethan Vaughan]

@Dario B I am running this script successfully but I am interested in finding an alternative to this script that will run the backup for server. How can I modify this script to grab that backup instead of the backup for Cloud?

Background; we're trying to develop a method of off-site automated backups.

Thanks,

[Dario B]

Hello @Ethan Vaughan ,

I am only working with Cloud products so I might not be the best person to help here.

However, once this has been said, as mentioned in Configuring automatic database backups documentation page, for PROD Jira Server and Datacenter sites we advise to take DB backups instead:

For large Jira installations and regular backups in production, we strongly recommend that you use native database backup tools instead of Jira's XML backup service.

Native database backup tools offer a much more consistent and reliable means of storing (and restoring) data while Jira is active. When Jira is in use, there’s no guarantee that XML backups will be consistent as the database may be updated during the backup process. Jira doesn't report any warnings or error messages when an XML backup is generated with inconsistencies and such backups will fail during the restore process.

For more details on this please see the Backing up data documentation page.

If for some reason this is not desired, another option would be to install Jira Server on a VM and take snapshots.

Finally, if you really want to have something like the Cloud backup scripts, you can proceed as it follows:

• Use username and password for basic authentication (instead of email and api token) as documented in: https://developer.atlassian.com/server/jira/platform/basic-authentication/
• Replace the products URLs with the right ones
• Confirm the REST API endpoint and the request body to be sent by running a backup from the UI with the developers tools open.

I hope this helps.