Add Backup Config
DescriptionConfigure backup of platform configuration; system settings, data sources, SMTP and SNMP settings, and more. This can be sent to a local filesystem, or a remove SSH or FTP server.
Request
URLURL
Request Body
{
"backup_file_server_type": "SSH",
"backup_schedule": {
"day_of_week": 1,
"enable": false,
"hour": 12,
"minute": 30,
"schedule_period": "DAILY"
},
"collector_mapping": {
"default_collector": "10.78.89.125",
"mappings": [
{
"destination": "10.78.89.126",
"source": "10.78.89.125"
}
]
},
"data_filter": {
"audit_logs_pii_status": true,
"ceip_status": true,
"data_management": true,
"data_sources": true,
"east_west_ip": true,
"events": true,
"ldap": true,
"north_south_ip": true,
"online_update_status": true,
"physical_ip_dns_mapping": true,
"physical_subnet_vlan": true,
"smtp": true,
"snmp": true,
"syslog": true,
"system_configuration": true,
"user_data": true,
"vidm": true,
"web_proxy": true
},
"ftp_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar",
"password": "password",
"port": 21,
"server_address": "10.234.12.134",
"username": "testuser"
},
"local_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"schedule_now": true,
"ssh_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar",
"password": "password",
"port": 22,
"server_address": "10.234.12.134",
"username": "testuser"
}
}
File Server type.
Possible values are: LOCAL , SSH , FTP
Mappings for source collector (backup setup) to destination collector (restore setup)
True, to run backup now (on demand)
Authentication
Response
Response BodyResponse Body
{
"backup_file_server_type": "SSH",
"backup_schedule": {
"day_of_week": 1,
"enable": false,
"hour": 12,
"minute": 30,
"schedule_period": "DAILY"
},
"collector_mapping": {
"default_collector": "10.78.89.125",
"mappings": [
{
"destination": "10.78.89.126",
"source": "10.78.89.125"
}
]
},
"data_filter": {
"audit_logs_pii_status": true,
"ceip_status": true,
"data_management": true,
"data_sources": true,
"east_west_ip": true,
"events": true,
"ldap": true,
"north_south_ip": true,
"online_update_status": true,
"physical_ip_dns_mapping": true,
"physical_subnet_vlan": true,
"smtp": true,
"snmp": true,
"syslog": true,
"system_configuration": true,
"user_data": true,
"vidm": true,
"web_proxy": true
},
"ftp_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar",
"password": "password",
"port": 21,
"server_address": "10.234.12.134",
"username": "testuser"
},
"local_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar"
},
"schedule_now": true,
"ssh_file_server": {
"backup_directory": "/home/testuser",
"backup_file_name": "vrni-backup-12-4-5.tar",
"password": "password",
"port": 22,
"server_address": "10.234.12.134",
"username": "testuser"
}
}
File Server type.
Possible values are: LOCAL , SSH , FTP
Mappings for source collector (backup setup) to destination collector (restore setup)
True, to run backup now (on demand)
Errors
Code Samples