Get Single Backup Object

Product version: 10.11

Last modified: 31 July 2024

Gets backup details.

Endpoint

https://<Director_IP_address>:4443/c/router

Tenant Endpoint

For tenants of the multi-tenant product the endpoint must be:
https://<Director_IP_address>:4443/t/<tenant_UUID>/c/router

Request Example

curl

Copy

curl --request POST \
     --url https://<Director_IP_address>:4443/c/router \
     --header "content-type: application/json" \
     --cookie @cookies.txt \
     --data '{
            "action": "TapeBackupManagement",
            "method": "getBackupObject",
            "data": [23],
            "type": "rpc",
            "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`TapeBackupManagement`
`method`	string	`getBackupObject`
`data`	array	ID of the backup object
`type`	string	`rpc`
`tid`	int	1

Response Sample

curl

Copy

{
    "action": "TapeBackupManagement",
    "method": "getBackupObject",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "vid": "BACKUP_OBJECT-23",
        "name": "Centos7",
        "hvType": "VMWARE",
        "tapeCartridgeCount": 2,
        "savepointCount": 4,
        "firstSavepoint": "2019-03-22T14:20:37.644+07:00",
        "lastSavepoint": "2019-03-28T10:59:11.575+07:00",
        "locationNames": [
            "My office"        ],
        "totalSize": 0,
        "isOffline": false,
        "isMarkedAsFree": true,
        "incompleteBackups": false
    }
}

Response Fields

Field	Value	Description
`message`	string	Message if the request failed
`where`	string	Reference to the method where the problem occurred
`cause`	string	Cause of failure
data	Json	Backup object info. See the table below

data

Field	Type	Description
`vid`	string	Backup object VID
`name`	string	Backup object name
`hvType`	string	Platform type. Possible values: `VMWARE, AWS, HYPERV, NONE, PHYSICAL, NUTANIX`
`tapeCartridgeCount`	`long`	Number of tape cartridges
`savepointCount`	`long`	Number of recovery points
`firstSavepoint`	`DateTime`	Date of the first recovery point
`lastSavepoint`	`DateTime`	Date of the last recovery point
`locationNames`	array	Location names
`isOffline`	boolean	`true` if the tape cartridge is offline
`isMarkedAsFree`	boolean	`true` if the tape cartridge was marked as free
`incompleteBackups`	boolean	`true` if the backup object has incomplete backups