backup¶
Backup system files
backup Specification¶
Parameter Value Type operational Element Name backup Element URI /axapi/v3/backup Element Attributes backup_attributes Partition Visibility shared Schema backup schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
EXECUTE Object | POST | /axapi/v3/backup |
backup attributes¶
log
Description: log is a JSON Block. Please see below for log
Type: Object
Reference Object: /axapi/v3/backup/log
status
Description: status is a JSON Block. Please see below for status
Type: Object
Reference Object: /axapi/v3/backup/status
store
Description: store is a JSON Block. Please see below for store
Type: Object
Reference Object: /axapi/v3/backup/store
system
Description: system is a JSON Block. Please see below for system
Type: Object
Reference Object: /axapi/v3/backup/system
status¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
system¶
Specification Value Type object encrypt
Description Encrypt the backup file
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description password for the remote site
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
remote-file
Description profile name for remote url
Type: string
Format: url
store-name
Description Save backup store information
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
store¶
Specification Value Type object creat-cfg
Description: creat-cfg is a JSON Block. Please see below for store_creat-cfg
Type: Object
delete-cfg
Description: delete-cfg is a JSON Block. Please see below for store_delete-cfg
Type: Object
store_delete-cfg¶
Specification Value Type object delete
Description Delete store
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
store-name-del
Description profile name for deleting
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
store_creat-cfg¶
Specification Value Type object create
Description Create store
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
remote-file
Description profile name for remote url
Type: string
Format: url
store-name
Description profile name to store remote url
Type: string
Format: string-rlx
Maximum Length: 31 characters
Maximum Length: 1 characters
log¶
Specification Value Type object all
Description all log
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
core
Description Backup core files only
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
date
Description specify number of days
Type: number
Range: 1-31
day
Description Most recent day
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
expedite
Description Expedite the Backup
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
messages
Description Backup messages file only
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
month
Description Most recent month
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
password
Description password for the remote site
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
period
Description Specify backup period
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
remote-file
Description profile name for remote url
Type: string
Format: url
showtech
Description Backup showtech files only
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
stats-data
Description Backup web statistical data
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
store-name
Description Save backup store information
Type: string
Format: string-rlx
Maximum Length: 128 characters
Maximum Length: 1 characters
use-mgmt-port
Description Use management port as source port
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
week
Description Most recent week
Type: boolean
Supported Values: true, false, 1, 0
Default: 0