Manage Data Backup
This article lists REST API requests concerning data backup.
In general, the backup process can be initiated by sending a POST
request without any payload to this endpoint:
POST/app/rest/server/backup?includeConfigs=true&includeDatabase=true&includeBuildLogs=true&fileName=MyCustomBackup.zip
In this example, the backup will use the MyCustomBackup.zip
file and will include configuration, database, and build logs as scopes.
The request accepts the following parameters:
fileName
:string
— backup file nameaddTimestamp
:boolean
— append the timestamp to the file nameincludeConfigs
:boolean
— include projects/build configurations into backupincludeDatabase
:boolean
— include the database into backupincludeBuildLogs
:boolean
— include the build logs into backupincludePersonalChanges
:boolean
— include the personal changes into backupincludeRunningBuilds
:boolean
— include the builds which are currently running into backupincludeSupplimentaryData
:boolean
- include the supplementary data like external plugins into backup
The backup file will be created in the default backup directory (read more).
To get the current backup status (idle/running), use:
GET/app/rest/server/backup
Thanks for your feedback!