Configure Backup Config
Configure file server and timers for automated backup. If secret fields are omitted (password, passphrase) then use the previously set value.
Request
URI
PUT
https://nsxmanager.your.domain/api/v1/cluster/backups/config
COPY
Request Body
BackupConfiguration of type(s) application/json
Required
{
"backup_schedule": {
"resource_type": "string"
},
"remote_file_server": {
"server": "string",
"protocol": {
"protocol_name": "string",
"ssh_fingerprint": "string",
"authentication_scheme": {
"username": "string",
"scheme_name": "string",
"password": "string"
}
},
"port": 0,
"directory_path": "string"
},
"passphrase": "string",
"backup_enabled": false,
"inventory_summary_interval": 0
}object
backup_schedule
Optional
Set when backups should be taken - on a weekly schedule or at regular intervals.
object
remote_file_server
Required
The server to which backups will be sent.
string
passphrase
Optional
passphrase
boolean
backup_enabled
Required
backup_enabled
integer As int64 As int64
inventory_summary_interval
Required
inventory_summary_interval
Responses
200
Success
Returns BackupConfiguration of type(s) application/json
{
"backup_schedule": {
"resource_type": "string"
},
"remote_file_server": {
"server": "string",
"protocol": {
"protocol_name": "string",
"ssh_fingerprint": "string",
"authentication_scheme": {
"username": "string",
"scheme_name": "string",
"password": "string"
}
},
"port": 0,
"directory_path": "string"
},
"passphrase": "string",
"backup_enabled": false,
"inventory_summary_interval": 0
}object
backup_schedule
Optional
Set when backups should be taken - on a weekly schedule or at regular intervals.
object
remote_file_server
Required
The server to which backups will be sent.
string
passphrase
Optional
passphrase
boolean
backup_enabled
Required
backup_enabled
integer As int64 As int64
inventory_summary_interval
Required
inventory_summary_interval
default
Unexpected error
Returns ApiError of type(s) application/json
{
"module_name": "string",
"error_message": "string",
"error_code": 0
}string
module_name
Optional
module_name
string
error_message
Optional
error_message
integer As int64 As int64
error_code
Optional
error_code