Get a List of Backup Objects

Product version: 10.11

Last modified: 31 July 2024

Returns a backup objects list.

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": "BackupManagement",
        "method": "getBackupObjects",
        "data": [{
                "filter": {
                        "start": 0,
                        "count": 9999,
                        "sort": "NAME",
                        "sortAsc": true,
                        "criteria": [{
                                "type": "EQ",
                                "name": "REPOSITORY_ID",
                                "value": 3}]}}],
        "type": "rpc",
        "tid": 1}'

Request Fields

Field	Type	Value(s)
`action`	string	`BackupManagement`
`method`	string	`getBackupObjects`
`data`	array	Array with one object that contains the `filter` field. The filtration parameters go inside `filter`. See the filter table below
`type`	string	`rpc`
`tid`	int	1

filter

Field	Type	Description
`start`	int	Zero-based position of the first backup object to return in the sorted list
`count`	int	Maximum count of backup objects
`useUnlimitedCount`	boolean	`true` if the count of backup objects is to be unlimited
`sort`	string	Field to sort by, for example `NAME`. Required: a request without `sort` fails
`sortAsc`	boolean	If `true` the list is sorted ascending
`sorts`	array	List form of `sort`. Not supported by this method on its own: a request with `sorts` and without `sort` fails. Use `sort`
`sortsAsc`	array	List form of `sortAsc`. Use `sortAsc` with this method
`criteria`	array	Filtration criteria. See below.

Criteria

Field	Type	Description	Possible value(s)
`type`	string	The type of criterion.	`AND, OR, EQ (equal), NEQ (not equal), LIKE (case sensitive), IN, BETWEEN, NOT_NULL, ILIKE, GT, GTE, LT, LTE`
`name`	string	The name of filtration criteria
`value`	depends on `name`	Value of the criterion. E.g., "name eq 5" – value is 5
`values`	`list`	Attribute values. Used for the `IN, BETWEEN` values of the `type` field

Response Sample

curl

Copy

{
    "action": "BackupManagement",
    "method": "getBackupObjects",
    "tid": "33",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [
            {
                "id": 7,
                "uuid": "e6c7a537-9e9a-4738-aa9b-2e4677f330fa",
                "name": "AD-EX2016-MK",
                "hvType": "VMWARE",
                "sourceType": "VM_BACKUP",
                "updated": "2017-07-28T14:18:32.356Z",
                "repositoryVid": "BACKUP_REPOSITORY-3",
                "transporterVid": "TRANSPORTER-1",
                "sourceUuid": "423b1a83-8836-08b7-92af-7fab4a62a107",
                "corrupted": 0,
                "consumed": 31858129852,
                "lockedShared": false,
                "lockedExclusive": false,
                "lockReasons": [],
                "isAccessible": true,
                "hasRootDisk": false,
                "status": "NONE",
                "lastSavePointCreatedDate": "2017-07-28T14:18:32.356Z"
            },
            {
                "id": 17,
                "uuid": "ac8d552d-362f-4ec4-8e9a-abb1153a317c",
                "name": "DC1",
                "hvType": "VMWARE",
                "sourceType": "VM_BACKUP",
                "updated": "2017-07-21T00:00:08.393Z",
                "repositoryVid": "BACKUP_REPOSITORY-3",
                "transporterVid": "TRANSPORTER-1",
                "sourceUuid": "42221eae-35b8-f407-3697-26dbe89b2565",
                "corrupted": 4,
                "consumed": 10266286464,
                "lockedShared": false,
                "lockedExclusive": false,
                "lockReasons": [],
                "isAccessible": true,
                "hasRootDisk": false,
                "status": "NONE",
                "lastSavePointCreatedDate": "2017-07-21T00:00:08.393Z"
            }
        ],
        "totalCount": 2
    }
}

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`	object	Object with the `children` array of backup objects and the `totalCount` field (number of backup objects that match the filter)

data.children (backup objects)

Field	Value	Description
`id`	long	Backup object ID
`uuid`	string	Backup object UUID
`name`	string	Display name
`hvType`	string	Platform type. Possible values: `VMWARE, AWS, HYPERV, NONE, PHYSICAL, NUTANIX`
`sourceType`	string	Source type. Possible values: `VM_BACKUP, SELF_BACKUP`
`updated`	string	Date and time last updated
`repositoryVid`	string	Repository VID
`transporterVid`	string	Assigned transporter VID
`sourceUuid`	string	The source UUID
`corrupted`	int	The number of corrupted job objects
`consumed`	long	Actual size of user data in the backup job object
`lockedShared`	boolean	`true` if multiple read operations cannot run on the same repository at the same time
`lockedExclusive`	boolean	`true` if multiple updates cannot be made to the repository at the same time
`lockReasons`	array	Lock reasons
`isAccessible`	boolean	If `true` the backup object is accessible
`hasRootDisk`	boolean	AWS-specific: backup count which savepoints have a Root volume
`status`	string	Status of the backup object. Possible values: `NONE, VERIFY_BACKUP, STOPPING_VERIFY_BACKUP`
`lastSavePointCreatedDate`	string	Date of the last save point creation