Get a List of Backup Objects Not Belonging to a Job

Returns a list of backup objects that do not belong to any job or a list of backup objects that do not belong to any job and are older than the specified number of days.

To bulk remove the chosen type of backup objects, note this request's response and proceed to Bulk Remove Backup Objects.

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 Examples

Excluding "Older Than" Parameter

curl

curl --request POST \
	--url https://<Director_IP_address>:4443/c/router \
	--header "content-type: application/json" \
	--cookie @cookies.txt \
	--data "{
    		"action": "BackupManagement",
    		"method": "collectBackupObjectRemoveList",
    		"data": [{
          			"removeOption": "NO_JOB_BACKUPS",
           			"olderThanDays": null,
           			"backupRepositoryId": 2
       			 	}],
    		"type": "rpc",
    		"tid": 1
			}"

Including "Older Than" Parameter

curl

curl --request POST \
	--url https://<Director_IP_address>:4443/c/router \
	--header "content-type: application/json" \
	--cookie @cookies.txt \
	--data "{
    		"action": "BackupManagement",
    		"method": "collectBackupObjectRemoveList",
    		"data": [{
          			"removeOption": "NO_JOB_BACKUPS_OLDER_THAN",
           			"olderThanDays": 30,
           			"backupRepositoryId": 2
       			 	}],
    		"type": "rpc",
    		"tid": 1
			}"

Request Fields

Field	Type	Value(s)
`action`	string	`BackupManagement`
`method`	string	`collectBackupObjectRemoveList`
`data`	array	The filtration parameters (see below)
`type`	string	`rpc`
`tid`	int	1

Data

Field

Type

Description

removeOption

string

"NO_JOB_BACKUPS" or "NO_JOB_BACKUPS_OLDER_THAN"

olderThanDays

int

If removeOption is set to "NO_JOB_BACKUPS": null

If removeOption is set to "NO_JOB_BACKUPS_OLDER_THAN": minimum age of the backup objects in days

backupRepositoryId int ID of the backup repository containing the backup objects

Response Sample

 {
    "action": "BackupManagement",
    "method": "collectBackupObjectRemoveList",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "items": [{
                "vid": "BACKUP_OBJECT-9",
                "parentVid": "BACKUP_REPOSITORY-2",
                "name": "Ubuntu",
                "timestamp": "2019-04-10T06:55:24.106-07:00"
            }, {
                "vid": "BACKUP_OBJECT-60",
                "parentVid": "BACKUP_REPOSITORY-2",
                "name": "VM",
                "timestamp": "2019-04-10T06:58:14.529-07:00"
            }, {
                "vid": "BACKUP_OBJECT-7",
                "parentVid": "BACKUP_REPOSITORY-2",
                "name": "Win7",
                "timestamp": "2019-04-10T06:52:01.905-07:00"
            }
        ],
        "totalDependSavepoints": 0
    }
}

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`	array	Parameters of the backup objects (see below)

data

Field	Value	Description
`items`	array	Backup object list (see below)
`totalDependSavepoints`	int	Number of recovery points dependent on the listed backup objects

data.items

Field	Value	Description
`vid`	string	Backup object VID
`parentVid`	string	Backup repository VID
`name`	string	Backup object name
`timestamp`	DateTime	Date and time the backup object was created

Page tree