Returns a backup objects list.
Endpoint
https://<Director_IP_address>:4443/c/router
Request Example
curl
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 |
|
method | string |
|
data | array | The filtration parameters |
type | string | rpc |
tid | int | 1 |
Data
Field | Type | Description |
---|---|---|
| int | The starting backup object ID |
| int | Maximum count of backup objects |
| boolean | true if the count of backup objects is to be unlimited |
| string | Sorting type |
| boolean | If true the list is sorted ascending |
| Json | Filtration criteria. See below. |
Criteria
Field | Type | Description | Possible value(s) |
---|---|---|---|
| string | The type of criterion. | AND, OR, EQ (equal), NEQ (not equal), LIKE (case sensitive), IN, BETWEEN, NOT_NULL, ILIKE, GT, GTE, LT, LTE |
| string | The name of filtration criteria | |
value | depends on name | Value of the criterion. E.g., "name eq 5" – value is 5 | |
| list | Attribute values. Used for the |
Response Sample
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 |
data.children (backup objects)
Field | Value | Description |
---|---|---|
id | long | Backup object ID |
| string | Backup object UUID |
| string | Display name |
hvType | string | Platform type. Possible values: VMWARE, AWS, HYPERV, NONE, PHYSICAL, NUTANIX |
| string | Source type. Possible values: |
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 |
| 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 |
| string | Status of the backup object. Possible values: |
| string | Date of the last save point creation |