API Reference

Page tree

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
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)
actionstring

BackupManagement

methodstring

getBackupObjects

dataarrayThe filtration parameters
typestringrpc
tidint1

Data

Field
Type
Description

start

intThe starting backup object ID

count

intMaximum count of backup objects

useUnlimitedCount

booleantrue if the count of backup objects is to be unlimited

sort

stringSorting type

sortAsc

booleanIf true the list is sorted ascending

criteria

JsonFiltration criteria. See below.

Criteria

FieldTypeDescriptionPossible value(s)
type
stringThe type of criterion.AND, OR, EQ (equal), NEQ (not equal), LIKE (case sensitive), IN, BETWEEN, NOT_NULL, ILIKE, GT, GTE, LT, LTE
name
stringThe name of filtration criteria
valuedepends on nameValue 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

 {
    "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",
                "updated": "2017-07-28T14:18:32.356Z",
                "repositoryVid": "BACKUP_REPOSITORY-3",
                "transporterVid": "TRANSPORTER-1",
                "sourceUuid": "423b1a83-8836-08b7-92af-7fab4a62a107",
                "corrupted": 0,
                "lockedShared": false,
                "lockedExclusive": false,
                "lockReasons": [],
                "isAccessible": true,
                "hasRootDisk": false
            },
            {
                "id": 17,
                "uuid": "ac8d552d-362f-4ec4-8e9a-abb1153a317c",
                "name": "DC1",
                "hvType": "VMWARE",
                "updated": "2017-07-21T00:00:08.393Z",
                "repositoryVid": "BACKUP_REPOSITORY-3",
                "transporterVid": "TRANSPORTER-1",
                "sourceUuid": "42221eae-35b8-f407-3697-26dbe89b2565",
                "corrupted": 4,
                "lockedShared": false,
                "lockedExclusive": false,
                "lockReasons": [],
                "isAccessible": true,
                "hasRootDisk": false
            }
}

Response Fields

Field
Value
Description
messagestringMessage if the request failed
wherestringReference to the method where the problem occurred
causestringCause of failure
dataarrayParameters of the backup objects

data.children (backup objects)

Field
Value
Description
idlongBackup object ID

uuid 

string Backup object UUID 

name

stringDisplay name
hvTypestringPlatform type. Possible values: VMWARE, AWS, HYPERV, NONE, PHYSICAL, NUTANIX

sourceType

string

Source type. Possible values: VM_BACKUP, SELF_BACKUP

updatedstringDate and time last updated
repositoryVidstringRepository VID
transporterVidstringAssigned transporter VID
sourceUuidstringThe source UUID
corruptedintThe number of corrupted job objects

consumed

long

Actual size of user data in the backup job object

lockedSharedbooleantrue if multiple read operations cannot run on the same repository at the same time
lockedExclusivebooleantrue if multiple updates cannot be made to the repository at the same time
lockReasonsarrayLock reasons
isAccessiblebooleanIf true the backup object is accessible
hasRootDiskbooleanAWS-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

  • No labels