Set whether stats collector backup uses Orchestrator backup configuration

post

http://127.0.0.1:8080/statsCollector/backup/useGmsConfig

Configures whether stats collector backup operations inherit settings from Orchestrator's backup configuration. When enabled without custom config, requires existing GMS backup configuration and schedule. Not supported in container mode deployments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Configuration object specifying whether to use Orchestrator backup settings. Optionally includes custom backup configuration with schedule when not using Orchestrator settings.

Request body for setting whether stats collector backup uses Orchestrator backup configuration. When useGmsBackupConfig is true without config, requires existing GMS backup configuration and schedule.

useGmsBackupConfig

boolean

required

If true, stats collectors inherit backup settings from Orchestrator's backup configuration. If false, custom backup configuration can be provided in the config property.

config

object

Custom backup configuration with schedule. Required when useGmsBackupConfig is false and you want to configure custom backup settings. Includes protocol, hostname, port, directory, username, password, maxBackups, description, and schedule.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

500

Internal Server Error. Unexpected error while updating configuration.

Language

Loading…

Response

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

application/json

text/plain

200Configuration updated successfully. Returns the new useGmsBackupConfig setting.

400Bad Request. Invalid configuration, missing GMS backup config, or missing GMS schedule when enabling Orchestrator config.

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