Test stats collector backup server connection

post

http://127.0.0.1:8080/statsCollector/backup/testConnection

Tests connectivity to a remote backup server for stats collector data. Validates credentials and network access before saving configuration. If password is omitted, the existing stored password is reused only when hostname, port, protocol, and username match the stored configuration. Not supported in container mode deployments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Backup server connection configuration to test. Password is optional only when hostname, port, protocol, and username match an existing stored configuration.

Request body for testing connectivity to a remote backup server. All fields except password are required for a complete test. If password is omitted, the existing stored password is reused only when hostname, port, protocol, and username match the stored configuration.

protocol

integer

enum

required

Transfer protocol for the backup connection. 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

required

1 to 65535

Port number for the connection. Common defaults: 21 (FTP), 22 (SCP/SFTP), 80 (HTTP), 443 (HTTPS).

directory

string

required

Target directory path on the remote server. For HTTP/HTTPS, this is the URL path.

username

string

required

Username for authentication with the remote server.

password

string

Password for authentication. Optional - if omitted, uses existing stored password from backup configuration.

maxBackups

integer

≥ 1

Defaults to 10

Maximum number of backup files to retain. Used for validation purposes.

description

string

Optional description for the backup configuration.

schedule

object

Optional schedule configuration. Not used during connection test but accepted for compatibility.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

500

Internal Server Error. An unexpected error occurred while testing the connection.

Language

Loading…

Response

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

application/json

text/plain

200Connection test successful. Returns a message describing the successful connection details.

400Bad Request. Connection test failed due to invalid configuration, authentication failure, or network issues.

401Unauthorized. Operation not supported in container mode or user lacks required READ_WRITE permission.