List Backup & Recovery Sessions

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_mob_sessions

Description

Lists all Backup & Recovery - previously known as Managed Online Backup - (MOB) sessions for a device.

Note:

Backups are recorded in batches after the whole batch finishes; once recorded the information about all backup sessions is available for the lifespan of the device, whilst Backup & Recovery remains enabled.
Please be aware that the backup values stated in this API call are in Bytes. If you require this information in Megabyte, divide the backup values by 1048576 (or backup value/1024/1024) and for Gigabytes divide the backup values by 1073741824 (or backup value/1024/1024/1024).

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_mob_sessions&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
deviceid	The deviceid must be a valid id	number	0	0

Optional parameters

Add optional parameters after the required parameters in the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_mob_sessions&required_parameters={parameter-value}&optional_parameters={parameter-value}

Parameter	Description	Type	Options	Default
describe	Optional. Returns a description of the entered call, the available parameters, an example of its output, and returned fields with descriptions.	boolean	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
deviceid	list_devices_at_client	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
	list_servers	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_servers&siteid=SITEID
	list_workstations	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_workstations&siteid=SITEID
siteid	list_sites	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_sites&clientid=CLIENTID
clientid	list_clients	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_clients

Examples

List Backup & Recovery sessions for a device

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_mob_sessions&deviceid=DEVICEID

Example response

<example>
<result created="2013-10-11T14:55:41+01:00" host="SERVER" status="OK">
  <session>
    <session_id>12345[unique id for the backup session]</session_id>
    <type>[one of: BACKUP, RESTORE]</type>
    <storage_account_id>139[id of the storage account used for storing this backup]</storage_account_id>
    <plugin>[one of: FILE_SYSTEM, SYSTEM_STATE, EXCHANGE, NETWORK_SHARES, VMWARE, MSSQL, SHAREPOINT, ORACLE]</plugin>
    <start>2013-03-17 00:06:57[start time, UTC]</start>
    <end>2013-03-17 00:07:23[end time, UTC]</end>
    <selection_size>132579334528[size in bytes of all data included in this backup]</selection_size>
    <selection_item_count>22[number of items included in this backup]</selection_item_count>
    <size_change>843776[difference (in bytes) between this selection and the previous (using this plugin) selection; note there is no indiciation of bigger or smaller]</size_change>
    <item_count_change>2[absolute difference in the number of items included in this backup versus previous backup (using this plugin)]</item_count_change>
    <removed_item_count>0[number of items removed from backup storage as a result of this backup]</removed_item_count>
    <processed_size>132579334528[amount (in bytes) of data processed]</processed_size>
    <processed_item_count>22[number of items processed]</processed_item_count>
    <transferred_size>955045456[amount (in bytes) of data transferred]</transferred_size>
    <error_count>0[number of errors which occurred during this backup; no further information is available]</error_count>
    <status>[one of: COMPLETED, INTERRUPTED, COMPLETED_WITH_ERRORS, FAILED, NOT_STARTED, CANCELED]</status>
  </session>
  [...more session entries if they exist...]
</result>
</example>

Returned fields

A mob_sessions element containing zero or more entries (session elements in XML), each session having:

Field	Description
session_id	unique id for the backup session
type	BACKUP RESTORE
storage_account_id	id of the storage account used for storing this backup
plugin	FILE_SYSTEM SYSTEM_STATE EXCHANGE NETWORK_SHARES VMWARE MSSQL SHAREPOINT ORACLE
start	start time, UTC
end	end time, UTC
selection_size	size in bytes of all data included in this backup
selection_item_count	number of items included in this backup
size_change	difference (in bytes) between this selection and the previous (using this plugin) selection; note there is no indication of bigger or smaller
item_count_change	absolute difference in the number of items included in this backup versus previous backup (using this plugin)
removed_item_count	number of items removed from backup storage as a result of this backup
processed_size	amount (in bytes) of data processed
processed_item_count	number of items processed
transferred_size	amount (in bytes) of data transferred
error_count	number of errors which occurred during this backup; no further information is available
status	COMPLETED INTERRUPTED COMPLETED_WITH_ERRORS FAILED NOT_STARTED CANCELED