Page tree

Returns the list of the recovery points of the specified backup object.

This method can be used for purposes other than getting the recovery points list. This article describes this particular application of the method.

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": "InventoryManagement",
			"method": "list",
			"data": [{
					"nodeType": "BACKUP_OBJECT",
					"nodeId": 16,
					"includeTypes": ["SAVEPOINT"]}],
			"type": "rpc",
			"tid": 1}"

Request Fields

Field
Type
Value(s)
actionstring

InventoryManagement

methodstring

list

dataarrayRequest parameters. See below
typestringrpc
tidinteger1

Data

Field
Type
Description
nodeTypestringThe type of node. Must be BACKUP_OBJECT in this case
nodeIdintThe ID of the backup object

includeNodeToo

boolean

If true, returns the parent node too

includeTypesarray of stringMust be SAVEPOINT in this case

Response Sample

 {
    "action": "InventoryManagement",
    "method": "list",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "children": [
            {
                "extendedInfo": null,
                "identifier": 243,
                "vid": "SAVEPOINT-243",
                "type": "SAVEPOINT",
                "subType": null,
                "name": "VoT-NBR",
                "description": null,
                "accessible": true,
                "isDisabled": false,
                "replicable": false,
                "hvType": "NONE",
                "flags": 0,
                "children": null
            }
}

Response Fields

Field
Value
Description
messagestringMessage if the request failed
wherestringReference to the method where the problem occurred
causestringCause of failure
dataJsonThe parameters of the recovery points

data.children

Field
Value
Description

extendedInfo


Extended info (if present)
identifierlongRecovery point ID
vidstringRecovery point VID
typestringType of the object. SAVEPOINT in this case
subTypestringThe subtype of the object. Not applicable in this case
namestringDisplay name
descriptionstringDescription (null if absent)
accessiblebooleanIf true, the object is accessible
isDisabled

boolean

Checks if the object is accessible
replicablebooleanChecks if the object is replicable
hvTypestringPlatform type. Not applicable in this case (NONE)
flagsint

For VMware ESXi hosts:

  • 0th bit checks if the ESXi host is free;
  • 1st bit checks if the host is managed by vCenter
childrenarrayThe children objects. Not applicable in this case
  • No labels