Create or update orchestrator backup configuration

post

http://127.0.0.1:8080/gms/backup/config

Creates or updates the orchestrator backup configuration for scheduled database backups. If password is empty or null, preserves the existing stored password. Password is encrypted before storage. Clears the BACKUP_CONFIGURATION_NOT_SET alarm on first configuration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Backup server connection configuration. Protocol and hostname are required.

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

200Backup configuration created or updated. Returns the configuration ID.

400Validation error. Invalid protocol value or malformed request body.

401Unauthorized. Requires READ_WRITE permission on the orchestrator.

500Internal server error during configuration save or password encryption.