GET /config/backup_and_restore/scheduled_backup_configurations
Retrieves a list of Backup Configurations.
Retrieves a list of Backup Configurations.
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields |
query |
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. |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The list of Backup Configurations was retrieved. |
|
500 |
1000 |
An error occurred during the attempt to retrieve the list of Backup Configurations. |
Response Description
A list of Backup Configuration objects 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.
Response Sample
[
{
"backup_directory_path": "String",
"backup_retention_period": 42,
"configuration_backup_enabled": true,
"configuration_backup_priority": "String <one of: LOW, MEDIUM, HIGH>",
"configuration_backup_time_limit": 42,
"configuration_id": 42,
"data_backup_host_configuration": [
{
"event_data_backup_enabled": true,
"flow_data_backup_enabled": true,
"host_id": 42
}
],
"data_backup_priority": "String <one of: LOW, MEDIUM, HIGH>",
"data_backup_time_limit": 42
}
]