Test remote backup server connection

post

http://127.0.0.1:8080/gms/backup/testConnection

Tests connectivity to the remote backup server by uploading a temporary test file, verifying its presence, and deleting it. If password is empty or null, uses the existing stored password from the database. Supports FTP, SCP, SFTP, HTTP, and HTTPS protocols.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Backup server connection configuration for testing. If password is omitted or empty, the existing stored password is used.

Configuration object for orchestrator backup to a remote server.

protocol

integer

enum

required

Defaults to 2

Transfer protocol type for backup. Values: 1=None, 2=FTP, 3=SCP, 4=HTTP, 5=HTTPS, 6=SFTP.

Allowed:

hostname

string

required

Hostname or IP address of the remote backup server.

port

integer

1 to 65535

Defaults to 21

Port number for the remote server connection. Default ports: FTP=21, SCP/SFTP=22, HTTP=80, HTTPS=443.

directory

string

required

Directory path on the remote server where backups will be stored. For HTTP/HTTPS, this is the URL path.

username

string

required

Username for authentication with the remote server.

password

string

Password for authentication. When updating, leave empty to preserve existing password.

maxBackups

integer

≥ 1

Defaults to 10

Maximum number of backup files to retain on the remote server. Oldest backups are deleted when limit is exceeded.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Connection test successful. The test creates a temporary file, uploads it to the remote server, verifies it exists, and deletes it. Returns protocol-specific success message.

400Connection test failed due to protocol-specific error or invalid configuration.

401Unauthorized. Requires READ_WRITE permission on the orchestrator.

500Internal server error during connection test.