Backup configuration operations#

When trying to determine how often to back up a file in your backup configuration, there are three variables to consider:

How important is tracking changes in the file to your business processes? (criticality)
How large is the file? (size)
How often does the file change? (data churn)

Criticality is the most important factor to consider when making backup decisions. The more critical the file is to your business operations, the more often you’ll want to back this file up. Size is an important consideration if the speed of backups/restores is important to you. Large files take longer to backup and to restore. It might be wise to backup large files less frequently. Data churn is the last variable to consider, and perhaps the trickiest to handle. Files that change often invalidate blocks that have been stored previously. Depending on criticality, it might still be wise to snapshot files with high data churn and backup those snapshots.

This section describes the backup configuration operations that are supported by the Cloud Backup API.

Create a backup configuration#

POST /v1.0/{tenant_id}/backup-configuration

This operation creates a backup configuration for the authenticated user. Returns details of a backup configuration.

To view a list of all backup configurations, use List all backup configurations for an agent.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
409	Conflict	The request could not be completed due to a conflict with the current state of the resource.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.

This table shows the body parameters for the request:

Name	Type	Description
BackupConfigurationName	String (Required)	The name of the backup configuration. The configuration typically has the backup schedule, files to backup, and notification options.
MachineAgentId	String (Required)	ID that uniquely identifies a Cloud Backup agent.
IsActive	String (Required)	Indicates if a backup configuration is active. Valid values are true or false.
VersionRetention	String (Required)	Indicates how many days backup revisions are maintained. Valid values are 0, 30, and 60. 0 means indefinite.
Frequency	String (Required)	Frequency of backup schedule. Valid values are “Manually”, “Hourly”, “Daily”, and “Weekly”.
StartTimeHour	String (Required)	Indicates the hour when the backup runs. Valid values are 1 through 12, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeMinute	String (Required)	Indicates the minute when the backup runs. Valid values are 0 through 59, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeAmPm	String (Required)	Indicates AM or PM. Valid values are “AM” or “PM”, as well as null when the Frequency value is “Manually” or “Hourly”.
DayOfWeekId	String (Required)	Indicates the day of the week. Valid values are 0 through 6, with 0 representing Sunday and 6 representing Saturday. null is also a valid value when the Frequency value is “Manually” ,”Hourly”, or “Daily”.
HourInterval	String (Required)	Indicates the hour. Valid values are 1 through 23, as well as null when the Frequency value is “Manually” , “Daily”, or “Weekly”.
TimeZoneId	String (Required)	Specifies the time zone where the backup runs, for example “Eastern Standard Time”.
NotifyRecipients	String (Required)	Indicates the email address to notify in case of backup success or failure.
NotifySuccess	String (Required)	Indicates if emails are sent after a successful backup. Valid values are true or false.
NotifyFailure	String (Required)	Indicates if emails are sent after a failed backup. Valid values are true or false.
Inclusions	String (Optional)	Indicates the list of files and folders to back up.
Exclusions	String (Optional)	Indicates the list of files and folders not to back up.

Example: Create backup configuration JSON request

{
    "MachineAgentId": 202743,
    "BackupConfigurationName": "Weekly Website Backup",
    "IsActive": true,
    "VersionRetention": 30,
    "MissedBackupActionId": 1,
    "Frequency": "Weekly",
    "StartTimeHour": 7,
    "StartTimeMinute": 30,
    "StartTimeAmPm": "PM",
    "DayOfWeekId": 5,
    "HourInterval": null,
    "TimeZoneId": "Eastern Standard Time",
    "NotifyRecipients": "test@my-email-address.com",
    "NotifySuccess": true,
    "NotifyFailure": true,
    "Inclusions": [
        {
            "FilePath": "C:\\backup_up_file.txt",
            "FileItemType": "File"
        },
        {
            "FilePath": "C:\\backed_up_folder",
            "FileItemType": "Folder"
        }
    ],
    "Exclusions": [
        {
            "FilePath": "C:\\backed_up_folder\\excluded_file.txt",
            "FileItemType": "File"
        }
    ]
}

Response#

This table shows the body parameters for the response:

Name	Type	Description
MachineAgentId	String	ID that uniquely identifies a Cloud Backup agent.
BackupConfigurationName	String	The name of the backup configuration. The configuration typically has the backup schedule, files to backup, and notification options.
IsActive	String	Indicates if a backup configuration is active. Valid values are true or false.
VersionRetention	String	Indicates how many days backup revisions are maintained. Valid values are 0, 30, and 60. 0 means indefinite.
BackupConfigurationScheduleId	String	Uniquely identifies the schedule that is associated with this configuration.
MissedBackupActionId	String	Specifies when to send notification. Valid values are as follows: 1 that indicates that notifications are sent as soon as possible, or 2 that indicates that notifications are sent at the next scheduled time.
Frequency	String	Frequency of backup schedule. Valid values are “Manually”, “Hourly”, “Daily”, and “Weekly”.
StartTimeHour	String	Indicates the hour when the backup runs. Valid values are 1 through 12, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeMinute	String	Indicates the minute when the backup runs. Valid values are 0 through 59, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeAmPm	String	Indicates AM or PM. Valid values are “AM” or “PM”, as well as null when the Frequency value is “Manually” or “Hourly”.
DayOfWeekId	String	Indicates the day of the week. Valid values are 0 through 6, with 0 representing Sunday and 6 representing Saturday. null is also a valid value when the Frequency value is “Manually”, “Hourly”, or “Daily”.
HourInterval	String	Indicates the hour. Valid values are 1 through 23, as well as null when the Frequency value is “Manually” ,”Daily”, or “Weekly”.
TimeZoneId	String	Specifies the time zone where the backup runs, for example “Eastern Standard Time”.
NotifyRecipients	String	Indicates the email address to notify in case of backup success or failure.
NotifySuccess	String	Indicates if emails are sent after a successful backup. Valid values are true or false.
NotifyFailure	String	Indicates if emails are sent after a failed backup. Valid values are true or false.
Inclusions	String (Optional)	Indicates the list of files and folders to back up.
Exclusions	String (Optional)	Indicates the list of files and folders not to back up.

Example: Create backup configuration JSON response

{
    "BackupConfigurationId": 174084,
    "BackupConfigurationName": "Weekly Website Backup",
    "BackupConfigurationScheduleId": 173131,
    "BackupPostscript": "",
    "BackupPrescript": "",
    "Datacenter": "DFW",
    "DayOfWeekId": 5,
    "EncryptionKey": {
        "ExponentHex": 10001,
        "ModulusHex": "C6054E90E32D2B25E16F3A560E1B4DC580B1E4AB74E0C662680DD8A1BD83956051F6A526B16C55225D1BE6E0B1265F4085FB2F61B61337F5D32198E5CAFFEACD50E90517A329146E43B20194C082A9C890060AD07A542FBC035B2A96F9F212C6D94887BECB5E15F3E55397B975B1896CFC66EBB5DD7D83587467A0E7F669ADB925A7BE4C1ECED1BC9E92DB768CE76FDC86CCDD04BDF469679FE3261AA66C22AC6263E540B79780AAF09CFC798CDC4D1218867388632EA4BD1BF511E4881E07C5387DDDBE741E615ACA0C32A738F5B952F1C17051EC3BAF9F64C629515EA2AF93E6BB450A8B1B3E02963471679D5670AF93CFEA649172EDA7AC5E071E2D3AF0BD"
    },
    "Exclusions": [
        {
            "FileId": 657293,
            "FileItemType": "File",
            "FilePath": "C:\\backed_up_folder\\excluded_file.txt",
            "FilePathEncoded": null,
            "Filter": "Exclude",
            "ParentId": 174084
        }
    ],
    "Flavor": "RaxCloudServer",
    "Frequency": "Weekly",
    "HourInterval": null,
    "Inclusions": [
        {
            "FileId": 657291,
            "FileItemType": "File",
            "FilePath": "C:\\backup_up_file.txt",
            "FilePathEncoded": null,
            "Filter": "Include",
            "ParentId": 174084
        },
        {
            "FileId": 657292,
            "FileItemType": "Folder",
            "FilePath": "C:\\backed_up_folder",
            "FilePathEncoded": null,
            "Filter": "Include",
            "ParentId": 174084
        }
    ],
    "IsActive": true,
    "IsDeleted": false,
    "IsEncrypted": false,
    "LastRunBackupReportId": null,
    "LastRunTime": null,
    "MachineAgentId": 202743,
    "MachineName": "web2",
    "MissedBackupActionId": 1,
    "NextScheduledRunTime": "/Date(1406935800000)/",
    "NotifyFailure": true,
    "NotifyRecipients": "test@my-email-address.com",
    "NotifySuccess": true,
    "StartTimeAmPm": "PM",
    "StartTimeHour": 11,
    "StartTimeMinute": 30,
    "TimeZoneId": "Eastern Standard Time",
    "VersionRetention": 30
}

Update a backup configuration#

PUT /v1.0/{tenant_id}/backup-configuration/{backupConfigurationId}

This operation updates an existing backup configuration.

Note

To view a list of all backup configurations and their backup configuration schedule IDs, see List backup configuration details.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.
{backupConfigurationId}	Integer	The unique identifier of the backup configuration.

This table shows the body parameters for the request:

Name	Type	Description
MachineAgentId	String (Required)	ID that uniquely identifies a Cloud Backup agent.
BackupConfigurationName	String (Required)	The name of the backup configuration. The configuration typically has the backup schedule, files to backup, and notification options.
IsActive	String (Required)	Indicates if a backup configuration is active. Valid values are true or false.
VersionRetention	String (Required)	Indicates how many days backup revisions are maintained. Valid values are 0, 30, and 60. 0 means indefinite.
BackupConfigurationScheduleId	String (Required)	Uniquely identifies the schedule that is associated with this configuration.
Frequency	String (Required)	Frequency of backup schedule. Valid values are “Manually”, “Hourly”, “Daily”, and “Weekly”.
StartTimeHour	String (Required)	Indicates the hour when the backup runs. Valid values are 1 through 12, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeMinute	String (Required)	Indicates the minute when the backup runs. Valid values are 0 through 59, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeAmPm	String (Required)	Indicates AM or PM. Valid values are “AM” or “PM”, as well as null when the Frequency value is “Manually” or “Hourly”.
DayOfWeekId	String (Required)	Indicates the day of the week. Valid values are 0 through 6, with 0 representing Sunday and 6 representing Saturday. null is also a valid value when the Frequency value is “Manually”, “Hourly”, or “Daily”.
HourInterval	String (Required)	Indicates the hour. Valid values are 1 through 23, as well as null when the Frequency value is “Manually” ,”Daily”, or “Weekly”.
TimeZoneId	String (Required)	Specifies the time zone where the backup runs, for example “Eastern Standard Time”.
NotifyRecipients	String (Required)	Indicates the email address to notify in case of backup success or failure.
NotifySuccess	String (Required)	Indicates if emails are sent after a successful backup. Valid values are true or false.
NotifyFailure	String (Required)	Indicates if emails are sent after a failed backup. Valid values are true or false.
Inclusions	String (Optional)	Indicates the list of files and folders to back up.
Exclusions	String (Optional)	Indicates the list of files and folders not to back up.

Example: Update backup configuration JSON request

{
    "MachineAgentId": 156953,
    "BackupConfigurationName": "Weekly Website Backup",
    "IsActive": true,
    "VersionRetention": 30,
    "BackupConfigurationScheduleId": 145393,
    "MissedBackupActionId": 1,
    "Frequency": "Weekly",
    "StartTimeHour": 6,
    "StartTimeMinute": 30,
    "StartTimeAmPm": "AM|PM",
    "DayOfWeekId": 4,
    "HourInterval": null,
    "TimeZoneId": "Eastern Standard Time",
    "NotifyRecipients": "raxtestaddress@rackspace.com",
    "NotifySuccess": true,
    "NotifyFailure": true,
    "Inclusions": [
        {
            "FilePath": "C:\\backup_up_file.txt",
            "FileItemType": "File"
        },
        {
            "FilePath": "C:\\backed_up_folder",
            "FileItemType": "Folder"
        }
    ],
    "Exclusions": [
        {
            "FilePath": "C:\\backed_up_folder\\excluded_file.txt",
            "FileItemType": "File"
        },
        {
            "FilePath": "C:\\backed_up_folder\\excluded_folder",
            "FileItemType": "Folder"
        }
    ]
}

Response#

This operation does not return a response body.

List backup configuration details#

GET /v1.0/{tenant_id}/backup-configuration/{backupConfigurationId}

This operation lists detailed information for the specified backup configuration.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.
{backupConfigurationId}	Integer	The unique identifier of the backup configuration.

This operation does not accept a request body.

Example: List backup configuration details JSON request

GET https://dfw.backup.api.rackspacecloud.com/v1.0/1234/backup-configuration/148325
User-Agent: controlpanel.drivesrvr.com
Host: dfw.backup.api.rackspacecloud.com
Content-Type: application/json;
Content-Length: 0
X-Auth-Token: 95b1788906f74d279d03001c6a14f3fe

Response#

This table shows the body parameters for the response:

Name	Type	Description
BackupConfigurationId	String	Autogenerated ID that uniquely identifies a backup configuration. This ID is required on subsequent GET/UPDATE/DELETE calls.
MachineAgentId	String	ID that uniquely identifies a Cloud Backup agent.
MachineName	String	Name of the Cloud Server where the Cloud Backup agent resides.
Flavor	String	RaxCloudServer - for Rackspace Cloud Servers.
BackupConfigurationName	String	The name of the backup configuration. The configuration typically has the backup schedule, files to backup, and notification options.
IsActive	String	Indicates if a backup configuration is active. Valid values are true or false.
IsDeleted	String	Indicates if the backup configuration is deleted. Valid values are true or false.
VersionRetention	String	Indicates how many days backup revisions are maintained. Valid values are 0, 30 , and 60. 0 means indefinite.
BackupConfigurationScheduleId	String	Uniquely identifies the schedule that is associated with this configuration.
MissedBackupActionId	String	Specifies when to send notification. Valid values are as follows: 1 that indicates that notifications are sent as soon as possible, or 2 that indicates that notifications are sent at the next scheduled time.
Frequency	String	Frequency of backup schedule. Valid values are “Manually”, “Hourly”, “Daily”, and “Weekly”.
StartTimeHour	String	Indicates the hour when the backup runs. Valid values are 1 through 12, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeMinute	String	Indicates the minute when the backup runs. Valid values are 0 through 59, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeAmPm	String	Indicates AM or PM. Valid values are “AM” or “PM”, as well as null when the Frequency value is “Manually” or “Hourly”.
DayOfWeekId	String	Indicates the day of the week. Valid values are 0 through 6, with 0 representing Sunday and 6 representing Saturday. null is also a valid value when the Frequency value is “Manually”, “Hourly”, or “Daily”.
HourInterval	String	Indicates the hour. Valid values are 1 through 23, as well as null when the Frequency value is “Manually” ,”Daily”, or “Weekly”.
TimeZoneId	String	Specifies the time zone where the backup runs, for example “Eastern Standard Time”.
NotifyRecipients	String	Indicates the email address to notify in case of backup success or failure.
NotifySuccess	String	Indicates if emails are sent after a successful backup. Valid values are true or false.
NotifyFailure	String	Indicates if emails are sent after a failed backup. Valid values are true or false.
Inclusions	String	Indicates the list of files and folders to back up.
Exclusions	String	Indicates the list of files and folders not to back up.

Example: List backup configuration details JSON response

{
    "BackupConfigurationId": 148325,
    "MachineAgentId": 156953,
    "MachineName": "Web Server",
    "Flavor": "RaxCloudServer",
    "IsEncrypted": false,
    "BackupConfigurationName": "Weekly Website Backup",
    "IsActive": true,
    "IsDeleted": false,
    "VersionRetention": 60,
    "BackupConfigurationScheduleId": 145406,
    "MissedBackupActionId": 1,
    "Frequency": "Weekly",
    "StartTimeHour": 11,
    "StartTimeMinute": 30,
    "StartTimeAmPm": "AM",
    "DayOfWeekId": 4,
    "HourInterval": null,
    "TimeZoneId": "Eastern Standard Time",
    "NextScheduledRunTime": "\/Date(1357817400000)\/",
    "LastRunTime": null,
    "LastRunBackupReportId": null,
    "NotifyRecipients": "raxtestaddress@rackspace.com",
    "NotifySuccess": false,
    "NotifyFailure": false,
    "Inclusions": [
      {
        "FilePath": "C:\\backed_up_folder",
        "ParentId": 148325,
        "FileItemType": "Folder",
        "FileId": 35000
      },
      {
        "FilePath": "C:\\backup_up_file.txt",
        "ParentId": 148325,
        "FileItemType": "File",
        "FileId": 34999
      }
    ],
    "Exclusions":[
      {
        "FilePath": "C:\\backed_up_folder\\excluded_folder",
        "ParentId": 148325,
        "FileItemType": "Folder",
        "FileId": 35002
      },
      {
        "FilePath": "C:\\backed_up_folder\\excluded_file.txt",
        "ParentId": 148325,
        "FileItemType": "File",
        "FileId": 35001
      }
    ]
}

List all backup configurations for the user#

GET /v1.0/{tenant_id}/backup-configuration

This operation lists all backup configurations for the current user.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.

This operation does not accept a request body.

Response#

This table shows the body parameters for the response:

Name	Type	Description
BackupConfigurationId	String	Autogenerated ID that uniquely identifies a backup configuration. This ID is required on subsequent GET/UPDATE/DELETE calls.
MachineAgentId	String	ID that uniquely identifies a Cloud Backup agent.
MachineName	String	Name of the Cloud Server where the Cloud Backup agent resides.
Flavor	String	RaxCloudServer - for Rackspace Cloud Servers.
IsEncrypted	String	Indicates if backups are encrypted. Valid values are true or false.
BackupConfigurationName	String	The name of the backup configuration. The configuration typically has the backup schedule, files to backup, and notification options.
IsActive	String	Indicates if a backup configuration is active. Valid values are true or false.
IsDeleted	String	Indicates if the backup configuration is deleted. Valid values are true or false.
VersionRetention	String	Indicates how many days backup revisions are maintained. Valid values are 0, 30 , and 60. 0 means indefinite.
BackupConfigurationScheduleId	String	Uniquely identifies the schedule that is associated with this configuration.
MissedBackupActionId	String	Specifies when to send notification. Valid values are as follows: 1 that indicates that notifications are sent as soon as possible, or 2 that indicates that notifications are sent at the next scheduled time.
Frequency	String	Frequency of backup schedule. Valid values are “Manually”, “Hourly”, “Daily”, and “Weekly”.
StartTimeHour	String	Indicates the hour when the backup runs. Valid values are 1 through 12, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeMinute	String	Indicates the minute when the backup runs. Valid values are 0 through 59, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeAmPm	String	Indicates AM or PM. Valid values are “AM” or “PM”, as well as null when the Frequency value is “Manually” or “Hourly”.
DayOfWeekId	String	Indicates the day of the week. Valid values are 0 through 6, with 0 representing Sunday and 6 representing Saturday. null is also a valid value when the Frequency value is “Manually”, “Hourly”, or “Daily”.
HourInterval	String	Indicates the hour. Valid values are 1 through 23, as well as null when the Frequency value is “Manually” ,”Daily”, or “Weekly”.
TimeZoneId	String	Specifies the time zone where the backup runs, for example “Eastern Standard Time”.
NextScheduledRunTime	String	Specifies the next scheduled run time for a backup.
LastRunTime	String	Indicates the last time a backup ran.
LastRunBackupReportId	String	If the backup ran successfully last time, indicates the ID of the backup report.
BackupState	String	Indicates the last state of the backup. These states can be “InProgress”, “Skipped”, “Queued”, or “Not Available”.
NotifyRecipients	String	Indicates the email address to notify in case of backup success or failure.
NotifySuccess	String	Indicates if emails are sent after a successful backup. Valid values are true or false.
NotifyFailure	String	Indicates if emails are sent after a failed backup. Valid values are true or false.
Inclusions	String	Indicates the list of files and folders to back up.
Exclusions	String	Indicates the list of files and folders not to back up.

Example: List all backup configurations for a user JSON response

 [
   {
   "BackupConfigurationId": 100850,
   "MachineAgentId": 96674,
   "MachineName": "Web Server",
   "Flavor": "RaxCloudServer",
   "IsEncrypted": false,
   "BackupConfigurationName": "Manual Website Backup",
   "IsActive": true,
   "IsDeleted": false,
   "VersionRetention": 60,
   "BackupConfigurationScheduleId": 98017,
   "MissedBackupActionId": 2,
   "Frequency": "Manually",
   "StartTimeHour": null,
   "StartTimeMinute": null,
   "StartTimeAmPm": "",
   "DayOfWeekId": null,
   "HourInterval": null,
   "TimeZoneId": "Eastern Standard Time",
   "NextScheduledRunTime": null,
   "LastRunTime": "\/Date(1343226053000)\/",
   "LastRunBackupReportId": 80071,
   "NotifyRecipients": "user@rackspace.com",
   "NotifySuccess": false,
   "NotifyFailure": true,
   "Inclusions": [
    {
      "FilePath": "/web/",
      "ParentId": 100850,
      "FileItemType": "Folder",
      "FileId": 2947
    }
  ],
   "Exclusions": [
    {
      "FilePath": "/web/cache/",
      "ParentId": 100850,
      "FileItemType": "Folder",
      "FileId": 2948
    }
  ]
    },
   {
   "BackupConfigurationId": 100928,
   "MachineAgentId": 96685,
   "MachineName": "Database Server",
   "Flavor": "RaxCloudServer",
   "IsEncrypted": false,
   "BackupConfigurationName": "Manual DB Backup",
   "IsActive": true,
   "IsDeleted": false,
   "VersionRetention": 60,
   "BackupConfigurationScheduleId": 98019,
   "MissedBackupActionId": 2,
   "Frequency": "Manually",
   "StartTimeHour": null,
   "StartTimeMinute": null,
   "StartTimeAmPm": "",
   "DayOfWeekId": null,
   "HourInterval": null,
   "TimeZoneId": "Eastern Standard Time",
   "NextScheduledRunTime": null,
   "LastRunTime": "\/Date(1343226074000)\/",
   "LastRunBackupReportId": 80116,
   "NotifyRecipients": "user@rackspace.com",
   "NotifySuccess": false,
   "NotifyFailure": true,
   "Inclusions": [
    {
      "FilePath": "/db/dumps/",
      "ParentId": 100928,
      "FileItemType": "Folder",
      "FileId": 3568
    }
  ],
   "Exclusions": [
    {
      "FilePath": "/db/dumps/tmp/",
      "ParentId": 100928,
      "FileItemType": "Folder",
      "FileId": 3570
    }
   ]
  }
]

List all backup configurations for an agent#

GET /v1.0/{tenant_id}/backup-configuration/system/{machineAgentId}

This operation lists the backup configurations for the specified agent.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.
{machingAgentId}	Integer	The unique identifier of the Cloud Backup agent.

This operation does not accept a request body.

Example: List all backup configurations for an agent JSON request

GET https://dfw.backup.api.rackspacecloud.com/v1.0/1234/backup-configuration/system/224193
User-Agent: controlpanel.drivesrvr.com
Host: dfw.backup.api.rackspacecloud.com
Content-Type: application/json;
Content-Length: 0
X-Auth-Token: 95b1788906f74d279d03001c6a14f3fe

Response#

This table shows the body parameters for the response:

Name	Type	Description
BackupConfigurationId	String	Autogenerated ID that uniquely identifies a backup configuration. This ID is required on subsequent GET/UPDATE/DELETE calls.
MachineAgentId	String	ID that uniquely identifies a Cloud Backup agent.
MachineName	String	Name of the Cloud Server where the Cloud Backup agent resides.
Flavor	String	RaxCloudServer - for Rackspace Cloud Servers.
IsEncrypted	String	Indicates if backups are encrypted. Valid values are true or false.
BackupConfigurationName	String	The name of the backup configuration. The configuration typically has the backup schedule, files to backup, and notification options.
IsActive	String	Indicates if a backup configuration is active. Valid values are true or false.
IsDeleted	String	Indicates if the backup configuration is deleted. Valid values are true or false.
VersionRetention	String	Indicates how many days backup revisions are maintained. Valid values are 0, 30, and 60. 0 means indefinite.
BackupConfigurationScheduleId	String	Uniquely identifies the schedule that is associated with this configuration.
MissedBackupActionId	String	Specifies when to send notification. Valid values are as follows: 1 that indicates that notifications are sent as soon as possible, or 2 that indicates that notifications are sent at the next scheduled time.
Frequency	String	Frequency of backup schedule. Valid values are “Manually”, “Hourly”, “Daily”, and “Weekly”.
StartTimeHour	String	Indicates the hour when the backup runs. Valid values are 1 through 12, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeMinute	String	Indicates the minute when the backup runs. Valid values are 0 through 59, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeAmPm	String	Indicates AM or PM. Valid values are “AM” or “PM”, as well as null when the Frequency value is “Manually” or “Hourly”.
DayOfWeekId	String	Indicates the day of the week. Valid values are 0 through 6, with 0 representing Sunday and 6 representing Saturday. null is also a valid value when the Frequency value is “Manually”, “Hourly”, or “Daily”.
HourInterval	String	Indicates the hour. Valid values are 1 through 23, as well as null when the Frequency value is “Manually” ,”Daily”, or “Weekly”.
TimeZoneId	String	Specifies the time zone where the backup runs, for example “Eastern Standard Time”.
NextScheduledRunTime	String	Specifies the next scheduled run time for a backup.
LastRunTime	String	Indicates the last time a backup ran.
LastRunBackupReportId	String	If the backup ran successfully last time, indicates the ID of the backup report.
NotifyRecipients	String	Indicates the email address to notify in case of backup success or failure.
NotifySuccess	String	Indicates if emails are sent after a successful backup. Valid values are true or false.
NotifyFailure	String	Indicates if emails are sent after a failed backup. Valid values are true or false.
Inclusions	String	Indicates the list of files and folders to back up.
Exclusions	String	Indicates the list of files and folders not to back up.

Example: List all backup configurations for an agent JSON response

[
    {
       "BackupConfigurationId": 158485,
       "MachineAgentId": 224193,
       "MachineName": "Web Server",
       "Flavor": "RaxCloudServer",
       "IsEncrypted": false,
       "BackupConfigurationName": "Manual Log Backup",
       "IsActive": true,
       "IsDeleted": false,
       "VersionRetention": 60,
       "BackupConfigurationScheduleId": 155566,
       "MissedBackupActionId": 1,
       "Frequency": "Manually",
       "StartTimeHour": null,
       "StartTimeMinute": null,
       "StartTimeAmPm": "",
       "DayOfWeekId": null,
       "HourInterval": null,
       "TimeZoneId": "Eastern Standard Time",
       "NextScheduledRunTime": "\/Date(-62135578800000)\/",
       "LastRunTime": null,
       "LastRunBackupReportId": null,
       "NotifyRecipients": "user@rackspace.com",
       "NotifySuccess": true,
       "NotifyFailure": true,
       "Inclusions": [
           {
               "FilePath": "C:\\Websites\\Logs",
               "ParentId": 158485,
               "FileItemType": "Folder",
               "FileId": 47085
           }
    ],
       "Exclusions": [ ]
 },
 {
       "BackupConfigurationId": 158486,
       "MachineAgentId": 224193,
       "MachineName": "Web Server",
       "Flavor": "RaxCloudServer",
       "IsEncrypted": false,
       "BackupConfigurationName": "Weekly Website Backup",
       "IsActive": true,
       "IsDeleted": false,
       "VersionRetention": 60,
       "BackupConfigurationScheduleId": 155567,
       "MissedBackupActionId": 1,
       "Frequency": "Weekly",
       "StartTimeHour": 7,
       "StartTimeMinute": 23,
       "StartTimeAmPm": "AM",
       "DayOfWeekId": 1,
       "HourInterval": null,
       "TimeZoneId": "Eastern Standard Time",
       "NextScheduledRunTime": "\/Date(1358752980000)\/",
       "LastRunTime": null,
       "LastRunBackupReportId": null,
       "NotifyRecipients": "user@rackspace.com",
       "NotifySuccess": true,
       "NotifyFailure": true,
       "Inclusions": [
            {
               "FilePath": "C:\\Websites",
               "ParentId": 158486,
               "FileItemType": "Folder",
               "FileId": 47086
            },
            {
               "FilePath": "C:\\Websites\\Logs",
               "ParentId": 158486,
               "FileItemType": "Folder",
               "FileId": 47087
            }
        ],
        "Exclusions": [ ]
    }
 ]

Enable or disable a backup configuration#

POST /v1.0/{tenant_id}/backup-configuration/enable/{backupConfigurationId}

This operation enables or disables a backup configuration.

Disabling a backup configuration does not delete it or its data. You can re-enabled disabled backup configurations later.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.
{backupConfigurationId}	Integer	The unique identifier of the backup configuration.

This table shows the body parameters for the request:

Name	Type	Description
Enable	String (Required)	Indicates if backup configuration is enabled (true) or disabled (false).

Example: Enable or disable a backup configuration request

POST https://dfw.backup.api.rackspacecloud.com/v1.0/1234/backup-configuration/enable/148325
User-Agent: controlpanel.drivesrvr.com
Host: dfw.backup.api.rackspacecloud.com
Content-Type: application/json;
Content-Length: 0
X-Auth-Token: 95b1788906f74d279d03001c6a14f3fe

Example: Enable a backup configuration JSON request

{
    "Enable": true
}

Example: Disable a backup configuration JSON request

{
    "Enable": false
}

Response#

This table shows the body parameters for the response:

Name	Type	Description
BackupConfigurationId	String	Autogenerated ID that uniquely identifies a backup configuration. This ID is required on subsequent GET/UPDATE/DELETE calls.
MachineAgentId	String	ID that uniquely identifies a Cloud Backup agent.
MachineName	String	Name of the Cloud Server where the Cloud Backup agent resides.
Flavor	String	RaxCloudServer - for Rackspace Cloud Servers.
IsEncrypted	String	Indicates if backups are encrypted. Valid values are true or false.
BackupConfigurationName	String	The name of the backup configuration. The configuration typically has the backup schedule, files to backup, and notification options.
IsActive	String	Indicates if a backup configuration is active. Valid values are true or false.
IsDeleted	String	Indicates if the backup configuration is deleted. Valid values are true or false.
VersionRetention	String	Indicates how many days backup revisions are maintained. Valid values are 0, 30, and 60. 0 means indefinite.
BackupConfigurationScheduleId	String	Uniquely identifies the schedule that is associated with this configuration.
MissedBackupActionId	String	Specifies when to send notification. Valid values are as follows: 1 that indicates that notifications are sent as soon as possible, or 2 that indicates that notifications are sent at the next scheduled time.
Frequency	String	Frequency of backup schedule. Valid values are “Manually”, “Hourly”, “Daily”, and “Weekly”.
StartTimeHour	String	Indicates the hour when the backup runs. Valid values are 1 through 12, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeMinute	String	Indicates the minute when the backup runs. Valid values are 0 through 59, as well as null when the Frequency value is “Manually” or “Hourly”.
StartTimeAmPm	String	Indicates AM or PM. Valid values are “AM” or “PM”, as well as null when the Frequency value is “Manually” or “Hourly”.
DayOfWeekId	String	Indicates the day of the week. Valid values are 0 through 6, with 0 representing Sunday and 6 representing Saturday. null is also a valid value when the Frequency value is “Manually”, “Hourly”, or “Daily”.
HourInterval	String	Indicates the hour. Valid values are 1 through 23, as well as null when the Frequency value is “Manually” ,”Daily”, or “Weekly”.
TimeZoneId	String	Specifies the time zone where the backup runs, for example “Eastern Standard Time”.
NotifyRecipients	String	Indicates the email address to notify in case of backup success or failure.
NotifySuccess	String	Indicates if emails are sent after a successful backup. Valid values are true or false.
NotifyFailure	String	Indicates if emails are sent after a failed backup. Valid values are true or false.
Inclusions	String	Indicates the list of files and folders to back up.
Exclusions	String	Indicates the list of files and folders not to back up.

Example: Disable a backup configuration JSON response

{
    "BackupConfigurationId": 148325,
    "MachineAgentId": 156953,
    "MachineName": "Web Server",
    "Flavor": "RaxCloudServer",
    "IsEncrypted": false,
    "BackupConfigurationName": "Weekly Website Backup",
    "IsActive": true,
    "IsDeleted": false,
    "VersionRetention": 60,
    "BackupConfigurationScheduleId": 145406,
    "MissedBackupActionId": 1,
    "Frequency": "Weekly",
    "StartTimeHour": 11,
    "StartTimeMinute": 30,
    "StartTimeAmPm": "AM",
    "DayOfWeekId": 4,
    "HourInterval": null,
    "TimeZoneId": "Eastern Standard Time",
    "NextScheduledRunTime": "\/Date(1357817400000)\/",
    "LastRunTime": null,
    "LastRunBackupReportId": null,
    "NotifyRecipients": "raxtestaddress@rackspace.com",
    "NotifySuccess": false,
    "NotifyFailure": false,
    "Inclusions": [
        {
            "FilePath": "C:\\backed_up_folder",
            "ParentId": 148325,
            "FileItemType": "Folder",
            "FileId": 35000
        },
        {
            "FilePath": "C:\\backup_up_file.txt",
            "ParentId": 148325,
            "FileItemType": "File",
            "FileId": 34999
        }
    ],
    "Exclusions":[
        {
            "FilePath": "C:\\backed_up_folder\\excluded_folder",
            "ParentId": 148325,
            "FileItemType": "Folder",
            "FileId": 35002
        },
        {
            "FilePath": "C:\\backed_up_folder\\excluded_file.txt",
            "ParentId": 148325,
            "FileItemType": "File",
            "FileId": 35001
        }
    ]
}

Delete a backup configuration#

DELETE /v1.0/{tenant_id}/backup-configuration/{backupConfigurationId}

This operation deletes the specified backup configuration.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.
{backupConfigurationId}	Integer	The unique identifier of the backup configuration.

This operation does not accept a request body.

Example: Delete a backup configuration JSON request

DELETE https://dfw.backup.api.rackspacecloud.com/v1.0/1234/backup-configuration/148325
User-Agent: controlpanel.drivesrvr.com
Host: dfw.backup.api.rackspacecloud.com
Content-Type: application/json;
Content-Length: 0
X-Auth-Token: 95b1788906f74d279d03001c6a14f3fe

Response#

This operation does not return a response body.