NSX-T Data Center REST API

Deprecated. Configure Restore SFTP server credentials (Deprecated)

Deprecated. Please use API /cluster/backups/config, to configure
remote file server(where backed-up files are stored) details
during restore. In older versions
- Configure file server where the backed-up files used for the Restore
operation are available.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/cluster/restore/config
/api/v1/cluster/restore/config

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

RestoreConfiguration+

Name	Description	Type	Notes
passphrase	Passphrase used to encrypt backup files.	string
remote_file_server	The server from which backup files will be retrieved for restore.	RemoteFileServer	Required

Example Request:

PUT https://<nsx-mgr>/api/v1/cluster/restore/config { "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" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

RestoreConfiguration+

Name	Description	Type	Notes
passphrase	Passphrase used to encrypt backup files.	string
remote_file_server	The server from which backup files will be retrieved for restore.	RemoteFileServer	Required

Required Permissions:

crud

Feature:

utilities_backup