POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id}

Update a Staged Backup Configuration.

Table 1: POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} resource details:
POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} resource details
MIME Type
application/json

Table 2: POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} request parameter details:
POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	Required. The ID for the Staged Backup Configuration to be updated.
fields	header	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} request body details:
POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} request body details
Parameter	Data Type	MIME Type	Description	Sample
backupConfiguration	Object	application/json	Required. A single Backup Configuration object that has the following modifiable fields: backup_directory_path - String - The file path for the backup archives folder. The default location is /store/backup. This path must exist before the backup process is initiated. If this path does not exist, the backup process aborts. backup_retention_period - Long - The backup retention period in milliseconds. This value will only have a granularity of days, and will be truncated. data_backup_host_configuration - Array[DataBackupHostConfiguration] - The hosts in the deployment that are configured for data backup. Each host can be configured to enable data backups for events, flows or both. The information for each host is as follows: host_id: The Id for the host. event_data_backup_enabled: Indicates whether event data backup is enabled for this host. flow_data_backup_enabled: Indicates whether flow data backup is enabled for this host. configuration_backup_enabled - Boolean - Indicates whether configuration backups are enabled. Setting this field false will keep the deployment configuration from being backed up. data_backup_priority - Enum - The priority (LOW, MEDIUM, HIGH) for the data backup process. Medium and high priorities have a greater negative effect on the performance of the server that is running the backup. configuration_backup_priority - Enum - The priority (LOW, MEDIUM, HIGH) for the config backup process. Medium and high priorities have a greater negative effect on the performance of the server that is running the backup. data_backup_time_limit - Long - The time limit for the data backup process. The value that you enter is converted to minutes. Minutes are converted to milliseconds by using milliseconds = minutes / 60000. configuration_backup_time_limit - Long - The time limit for the configuration backup process. The value that you enter is converted to minutes. Minutes are converted to milliseconds by using milliseconds = minutes / 60000. Any other set fields will be ignored.	{ "data_backup_host_configuration": [ { "flow_data_backup_enabled": true, "host_id": 53, "event_data_backup_enabled": true }, { "flow_data_backup_enabled": false, "host_id": 103, "event_data_backup_enabled": true } ], "data_backup_time_limit": 71160000, "data_backup_priority": "LOW", "configuration_backup_time_limit": 10800000, "backup_retention_period": 604800000, "configuration_id": 1, "configuration_backup_priority": "HIGH", "backup_directory_path": "/store/backup", "configuration_backup_enabled": true }

Table 4: POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} response codes:
POST /staged_config/backup_and_restore/scheduled_backup_configurations/{id} response codes
HTTP Response Code	Unique Code	Description
200		A Backup Configuration was updated.
404	1001	The Resource that requested by provided id does not exist.
422	1002	A request parameter is not valid.
422	1003	The 'backup_directory_path' does not exist. The default location is /store/backup.
422	1004	The 'backup_directory_path' is not in a valid format. The 'backup_directory_path' must be an absolute path to the directory, the default location is /store/backup.
422	1005	The 'backup_directory_path' is not a valid directory. The default location is /store/backup.
422	1006	The 'backup_retention_period' request parameter is not valid.
422	1007	The 'data_backup_time_limit' or 'config_backup_time_limit' parameter is not valid.
422	1008	The 'data_backup_time_limit' and 'config_backup_time_limit' parameters combine to a value that exceeds the limit.
422	1009	The requested Host was not activated.
422	1010	The requested host does not have data component.
500	1000	An error occurred during the attempt to update the Backup Configuration.

Response Description

The Configuration object containing the following fields:

configuration_id - Long - The ID for the backup configuration.
backup_directory_path - String - The file path for the backup archives folder. The default location is/store/backup. This path must exist before the backup process is initiated. If this path does not exist, the backup process aborts.
backup_retention_period - Long - The backup retention period in milliseconds. This value will only have a granularity of days, and will be truncated.
data_backup_host_configuration - Array[DataBackupHostConfiguration] - The hosts in the deployment that are configured for data backup. Each host can be configured to enable data backups for events, flows or both. The information for each host is as follows: host_id: The Id for the host. event_data_backup_enabled: Indicates whether event data backup is enabled for this host. flow_data_backup_enabled: Indicates whether flow data backup is enabled for this host.
configuration_backup_enabled - Boolean - Indicates whether configuration backups are enabled. Setting this field false will keep the deployment configuration from being backed up.
data_backup_priority - Enum - The priority (LOW, MEDIUM, HIGH) for the data backup process. Medium and high priorities have a greater negative effect on the performance of the server that is running the backup.
configuration_backup_priority - Enum - The priority (LOW, MEDIUM, HIGH) for the config backup process. Medium and high priorities have a greater negative effect on the performance of the server that is running the backup.
data_backup_time_limit - Long - The time limit for the data backup process. The value that you enter is converted to minutes. Minutes are converted to milliseconds by using milliseconds = minutes / 60000.
configuration_backup_time_limit - Long - The time limit for the configuration backup process. The value that you enter is converted to minutes. Minutes are converted to milliseconds by using milliseconds = minutes / 60000.

ON THIS PAGE

Response Description

Response Sample