System Administration > Lifecycle Management > Backup Restore Management > Backup

Configure backup

Configure file server and timers for automated backup.
If secret fields are omitted (password, passphrase)
then use the previously set value.

Request:

Method:
PUT
URI Path(s):
/api/v1/cluster/backups/config
Request Headers:
n/a
Query Parameters:
BackupFrameRequestParameters+
Request Body:
BackupConfiguration+

Example Request:

PUT https://<nsx-mgr>/api/v1/cluster/backups/config?site_id=fec18cee-ccf7-4d7c-bcc2-8634b08195cd&frame_type=LOCAL_MANAGER { "backup_enabled" : true, "backup_schedule":{ "resource_type": "WeeklyBackupSchedule", "days_of_week":[ 1, 3, 5 ], "hour_of_day":0, "minute_of_day":0 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin", "password":"default" } }, "directory_path":"/nsx-backups" }, "passphrase":"swordfish", "inventory_summary_interval":300 }| PUT https://<nsx-mgr>/api/v1/cluster/backups/config { "backup_enabled" : true, "backup_schedule":{ "resource_type": "IntervalBackupSchedule", "seconds_between_backups":3600 }, "remote_file_server":{ "server":"10.1.2.3", "port":22, "protocol":{ "protocol_name":"sftp", "ssh_fingerprint":"SHA256:w2NgXhG2Nm76q9PL/bXWKkLbDS31uMLYttUe9eajPaA", "authentication_scheme":{ "scheme_name":"PASSWORD", "username":"admin", "password":"default" } }, "directory_path":"/nsx-backups" }, "passphrase":"swordfish", "inventory_summary_interval":300 }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BackupConfiguration+

Required Permissions:

crud

Feature:

utilities_backup

Additional Errors: