Add or update stats collector backup configuration

post

http://127.0.0.1:8080/statsCollector/backup/config

Creates or updates the backup configuration for statistics collectors, including schedule settings. Not supported in container mode deployments. Can use Orchestrator's backup configuration or custom settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Backup configuration with optional schedule. Can be direct config or wrapped with useGmsBackupConfig flag.

Request body for creating/updating stats collector backup configuration. Supports two formats: direct config or wrapped with useGmsBackupConfig flag.

useGmsBackupConfig

boolean

If true, use Orchestrator's backup configuration instead of custom settings. When true and no config provided, GMS backup config must exist.

config

object

Nested config object when using wrapped format.

protocol

integer

enum

Defaults to 2

Transfer protocol: 1=none, 2=FTP, 3=SCP, 4=HTTP, 5=HTTPS, 6=SFTP.

Allowed:

hostname

string

Hostname or IP address of the remote backup server.

port

integer

Defaults to 21

Port number. Default varies by protocol (21 for FTP, 22 for SFTP/SCP).

directory

string

Target directory path on remote server.

username

string

Username for authentication.

password

string

Password for authentication. Stored encrypted.

maxBackups

integer

Defaults to 10

Maximum backup files to retain. Defaults to 10 if not specified.

description

string

Optional description for the backup configuration.

schedule

object

Backup schedule configuration.

Responses

200

Backup configuration saved successfully. No response body returned.

500

Internal Server Error. Unexpected error while saving backup configuration.

Language

Loading…

Response

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

text/plain

400Bad Request. Invalid configuration data or validation error.

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