Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /staged_config/backup_and_restore/scheduled_backup_configurations/{id}

SUMMARY Retrieves a Staged Backup Configuration by ID.

Retrieves a Staged Backup Configuration by ID.

Table 1: GET /staged_config/backup_and_restore/scheduled_backup_configurations/{id} resource details:

GET /staged_config/backup_and_restore/scheduled_backup_configurations/{id} resource details
MIME Type

application/json

Table 2: GET /staged_config/backup_and_restore/scheduled_backup_configurations/{id} request parameter details:

GET /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 get.

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.
Table 3: GET /staged_config/backup_and_restore/scheduled_backup_configurations/{id} response codes:

GET /staged_config/backup_and_restore/scheduled_backup_configurations/{id} response codes
HTTP Response Code Unique Code Description

200

A Backup Configuration was retrieved.

404

1001

The Resource that was requested by the provided id does not exist.

500

1000

An error occurred during the attempt to retrieve 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.

Response Sample