| name |
type |
description |
| database |
identifier |
Identifier of the database |
| name_database |
string |
Name of the database. Used only if database parameter is omitted. |
| sid |
string |
Session identifier for a server connection. Use the /server/login request to get a valid session identifier. |
| external_identifier |
string |
(Optional) Path to file with zip extension where the backup of the database will be saved |
| mode |
integer |
(Optional) Mode == 2 means chunked network transfer of zip file with backup via jedox client libraries. Mode == 1 is a direct download. Cannot be combined with external identifier. |
| show_system |
boolean |
(Optional) If in backup mode, include also System DB to the archive (default is 0). |
| type |
integer |
(Optional) 0 - save System DB as script. 1 - save as compressed folder. 2 - save both. (default is 0). |
| include_archive |
boolean |
(Optional) If in backup mode, include also archive files (default is 0). |
| show_audit |
boolean |
(Optional) If in backup mode, include also audit file to the archive (default is 0). |
| include_csv |
boolean |
(Optional) If in backup mode, include also csv files (default is 1). |
| password |
string |
(Optional) If in backup mode, encrypt archive with password. |