NSX-T Data Center REST API

Get backup configuration

Get a configuration of a file server and timers for automated backup.
Fields that contain secrets (password, passphrase) are not returned.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/cluster/backups/config
/api/v1/cluster/backups/config
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:

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

Example Response:

{ "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" } }, "directory_path":"/nsx-backups" }, "inventory_summary_interval":300 }

Required Permissions:

read

Feature:

utilities_backup

Additional Errors: