post_backups

(POST)/backups

Description

Returns the list of backups given the filters provided. This includes the detail drill-down information that is returned by the bp_get_backup_info BPL API, in addition to the bp_get_backup_status API.

Request

Syntax

POST /api/backups
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Name	Description	Type	Required
system_id	The system ID for the system for which we want to get backups	long	No
client_id	The ID of the client for which we want to get backups	long	No
instance_id	The ID of the protected instance for which we want to get backups	long	No
type	The backup type or types for which we want to get backups	array of strings	no
start_time	An epoch timestamp of the earliest status	long	No
end_time	An epoch timestamp of the start time of the most recent backup	long	No
start_day	date on which to start getting backup details, in mm/dd/yyyy format	string	optional
end_day	date on which to end getting backup details, in mm/dd/yyyy format	string	optional

• | if start_day and end_day are the same, gets backup details for just that day | finish_interval_start | An epoch timestamp specifying the earliest time at which a backup completed | long | No finish_interval_end| An epoch timestamp specifying the latest time at which a backup completed | long | No start_hours | Returns backups that started over the past hours | long | No end_hours | Returns backups that finished over the past hours | long | No backup_ids | A list of backup IDs to be returned | array | No

Response

Parameters

Index	Value	Type	Returned
id	Backup id	long	for types with backup id
client_id	Client id associated with this backup (if no backup id, this value will be id of the DPU client).	long	always
client_name	name of the client	string	always
type	pretty-printed backup type	string	always
start_date_time	formatted string of backup start date/time	string	always
duration	formatted string of backup duration	string	always
complete	Backup is complete?	boolean	always
status	Status of backup	string	always

• | None |
• | Success|
• | Warning |
• | Failure | size | Size of backup or vaulted backup, in MB | long | always sync_size | Size of data sync’d, in MB | long | for sync types files | Number of files backed up | long | for file types encrypted | Indicates whether or backup is encrypted (true) or not | boolean | always is_cluster | Indicates whether backup is for a vm managed by a hyper-v cluster client or now | boolean | for hyper-v apps guid | Hyper-V vm guid | string | for hyper-v apps vm_name | Name of virtual machine for Hyper-V types | string | for hyper-v apps replication_status | Whether or not the backup has been replicated | string | always
• | Not Applicable | |
• | Needed | |
• | Completed | |
• | In Progress | |
• | Waiting | | verified | Indicates whether or not the backup has been verified | boolean | for backup types verify_status | Whether or not the backup has been verified successfully | string | always
• | Not Applicable | |
• | Successful | |
• | Failed | | presync_seconds | Pre-sync portion of securesync elapsed time. | long | for sync types sync_seconds | Sync portion of securesync elapsed time | long | for sync types postsync_seconds | Post-sync portion of securesync elapsed time | long | for sync types sync_message | Output messages for securesync operations. Only returned when sync_msg is set to true in the backup status format array as defined in Table 57. Internally, the sds_stats table’s message column is the source of this data. This message must start with Success or Failure so that the API knows the status of the sync/replication operation. | string | optionally for sync types server_instance_name | Name of server instance for mssql or vmware backup types | string | for mssql or vm types database_name | Name of database for mssql backup types or database/storage group name for exchange backup types or virtual machine for vm types | string | for mssql, exchange, vm types server_name | Name of VMware vCenter or ESX server for vm types | string | for vm types vm_name | Name of virtual machine for vm types | string | for vm types instance_id | Application instance id associated with the backup | long | for application types app_id | ID of application associated with this backup (as returned by the applications field of bp_get_client_info) | long | for application types app_name | Name of application associated with this backup (as returned by the applications field of bp_get_client_info) | string | for application types synthesized | The backup was ‘synthesized’ by the appliance, not from a user backup | boolean | always synth_capable | The backup is capable of being part of a synthesis group, i.e., multiple backups may be viewed and restored as one. | boolean | always disk_metadata | The backup contains the disk metadata file for disk/volume layout. | boolean | always client_config | The backup contains a version of the disk metadata file that includes the configuration information needed for creating a virtual client | boolean | always restored_bkup_type | The backup type for this restore | string | for virtual restores only replicated | The backup has been replicated from another source system | boolean | always destination | Returns the name of the replication target | string | If set for sync types vmware_template | The backup is of a template rather than a VM | boolean | always certified | The backup has been certified as a valid recovery point. | boolean | always storage | The storage on which this backup is located, may be empty if backup failed | string | if available output | The formatted output returned during the backup | string | always purgeable | whether or not the backup is a candidate for purging | boolean | always last | whether or not this is the last backup for a particular protected asset | boolean | always legalhold | whether backup is on hold | boolean | always gfs_rp_type | type of GFS recovery point | always, may be empty

Examples

Sample Request

POST api/backups
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

Sample Response

{
    "backups": [
      {
       "id": 220,
       "type": "Differential",
       "client_id" : 2,
       "client_name": "win32",
       "instance_id": 23,
       "instance_name": "file-level",
       "start_date_time": "10/14/2014  09:32 am",
       "duration": "00:00:28",
       "complete": true,
       "status": "Success",
       "size": 518
       "files": 2462,
       "encrypted": false,
       "replication_status": "N/A",
       "verified": true,
       "verify_status": "Success",
       "synthesized": false,
       "synth_capable": true,
       "disk_metadata": false,
       "client_config": false,
       "replicated": false,
       "vm_ware_template": false,
       "certified": false
      }
   ]
}