List all Recovery Points

Returns a detailed list of all recovery points.

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

Exclude Expired Recovery Points

curl

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data "{
        "action": "JobSummaryManagement",
        "method": "listSavepoints",
        "data": [],
        "type": "rpc",
        "tid": 1}"

Include Expired Recovery Points

curl

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data "{
        "action": "JobSummaryManagement",
        "method": "listSavepoints",
        "data": [{includeExpiredSavepoints: true}],
        "type": "rpc",
        "tid": 1}"

Request Fields

Field	Type	Value(s)
`action`	string	`JobSummaryManagement`
`method`	string	`listSavepoints`
`data`	JSON array	See below. Leaving this field blank will automatically filter out expired recovery points.
`type`	string	`rpc`
`tid`	integer	`1`

data

Field	Type	Description
`includeExpiredSavepoints`	boolean	Choose whether to include expired recovery points in output.

Response Sample

{
    "action": "JobSummaryManagement",
    "method": "listSavepoints",
    "tid": "1",
    "type": "rpc",
    "message": null,
    "where": null,
    "cause": null,
    "data": {
        "backupRepositories": [
            {
                "id": 9,
                "vid": "BACKUP_REPOSITORY-9",
                "name": "Backblaze",
                "backupObjects": []
            },
            {
                "id": 2,
                "vid": "BACKUP_REPOSITORY-2",
                "name": "Onboard repository",
                "backupObjects": [
                    {
                        "id": 1,
                        "vid": "BACKUP_OBJECT-1",
                        "name": "Self-backup",
                        "savepoints": [
                            {
                                "id": 25,
                                "vid": "SAVEPOINT-25",
                                "name": "NAKIVO Backup & Replication",
                                "uuid": "Recovery point Sun, 03 Jul 2022 at 2:00:09 (UTC +03:00)",
                                "added": "2022-07-03T02:00:09.424+03:00",
                                "expired": null,
                                "type": "FULL",
                                "consumed": 2385264,
                                "checked": "2022-07-04T17:17:09.424+03:00",
                                "checkState": "VERIFIED"
                            },
                            {
                                "id": 26,
                                "vid": "SAVEPOINT-26",
                                "name": "NAKIVO Backup & Replication",
                                "uuid": "Recovery point Mon, 04 Jul 2022 at 2:00:00 (UTC +03:00)",
                                "added": "2022-07-04T02:00:00.929+03:00",
                                "expired": null,
                                "type": "FULL",
                                "consumed": 3385354,
                                "checked": "2022-07-04T17:17:09.424+03:00",
                                "checkState": "VERIFIED"
                            }
                        ]
                    }
                ]
            },
            {
                "id": 4,
                "vid": "BACKUP_REPOSITORY-4",
                "name": "s3",
                "backupObjects": [
                    {
                        "id": 2,
                        "vid": "BACKUP_OBJECT-2",
                        "name": "Centos2012",
                        "savepoints": [
                            {
                                "id": 3,
                                "vid": "SAVEPOINT-3",
                                "name": "Centos2012",
                                "uuid": "Recovery point Wed, 29 Jun 2022 at 15:48:40 (UTC +03:00)",
                                "added": "2022-06-29T15:48:40.936+03:00",
                                "expired": null,
                                "type": "FULL",
                                "consumed": 962364875,
                                "checked": null,
                                "checkState": "NEUTRAL"
                            },
                            {
                                "id": 19,
                                "vid": "SAVEPOINT-19",
                                "name": "Centos2012",
                                "uuid": "Recovery point Thu, 30 Jun 2022 at 0:00:02 (UTC +03:00)",
                                "added": "2022-06-30T00:00:02.828+03:00",
                                "expired": null,
                                "type": "INCREMENTAL",
                                "consumed": 0,
                                "checked": null,
                                "checkState": "NEUTRAL"
                            },
                            {
                                "id": 21,
                                "vid": "SAVEPOINT-21",
                                "name": "Centos2012",
                                "uuid": "Recovery point Thu, 30 Jun 2022 at 19:42:41 (UTC +03:00)",
                                "added": "2022-06-30T19:42:41.204+03:00",
                                "expired": null,
                                "type": "INCREMENTAL",
                                "consumed": 0,
                                "checked": null,
                                "checkState": "NEUTRAL"
                            },
                            {
                                "id": 23,
                                "vid": "SAVEPOINT-23",
                                "name": "Centos2012",
                                "uuid": "Recovery point Sat, 02 Jul 2022 at 0:00:05 (UTC +03:00)",
                                "added": "2022-07-02T00:00:05.951+03:00",
                                "expired": null,
                                "type": "INCREMENTAL",
                                "consumed": 0,
                                "checked": null,
                                "checkState": "NEUTRAL"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

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`	string	Recovery point information (see tables below)

backupRepositories

Field	Type	Description
`id`	int	Backup repository ID
`vid`	string	Backup repository VID
`name`	string	Backup repository display name
`backupObjects`	JSON array	List of backup objects in repository; see table below

backupObjects

Field	Type	Description
`id`	int	Backup object ID
`vid`	string	Backup object VID
`name`	string	Backup object display name
`savepoints`	JSON array	List of recovery points for backup object; see table below

savepoints

Field	Type	Description
`id`	int	Recovery point ID
`vid`	string	Recovery point VID
`name`	string	Backup object display name
`uuid`	string	Recovery point UUID
`added`	string	Date and time the recovery point was created
`expired`	string	Date and time the recovery point expired. If the recovery point has not expired, this value is `null`
`type`	string	Type of recovery point; `“INCREMENTAL”` or `“FULL”`
`consumed`	int	Space consumed by the recovery point in bytes
`checked`	string	Date and time of last recovery point verification. If the recovery point has not yet been verified, this value is `null`
`checkstate`	string	The state of the recovery point based on last verification. Possible values: `“VERIFIED”`: The recovery point is OK `“CORRUPTED”`: The recovery point is corrupted `“NEUTRAL”`: The recovery point has not yet been verified

Page tree

List all Recovery Points

Endpoint

Request Examples

Exclude Expired Recovery Points

Include Expired Recovery Points

Request Fields

data

Response Sample

Response Fields

backupRepositories

backupObjects

savepoints