Veeam Backup & Replication 13
REST API Reference
Related documents

Restore Points

The Restore Points section defines operations for retrieving restore points created on the backup server and backed up disks from the restore points.

Get All Restore Points

The HTTP GET request to the /api/v1/restorePoints endpoint gets an array of all restore points created on the backup server.

Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of restore points to skip.

limit
integer <int32>
Default: 200

Maximum number of restore points to return.

orderColumn
string (EObjectRestorePointsFiltersOrderColumn)

Sorts restore points by one of the restore point parameters.

Enum: "CreationTime" "PlatformId" "BackupId"
orderAsc
boolean

If true, sorts restore points in ascending order by the orderColumn parameter.

createdAfterFilter
string <date-time>

Returns restore points that are created after the specified date and time.

createdBeforeFilter
string <date-time>

Returns restore points that are created before the specified date and time.

nameFilter
string

Filters restore points by the nameFilter pattern. The pattern can match any restore point parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.

platformNameFilter
string (EPlatformType)

Filters restore points by the platform name of the backup object.

Enum: "VMware" "HyperV" "CloudDirector" "WindowsPhysical" "LinuxPhysical" "Tape" "CustomPlatform" "EntraID" "UnstructuredData" "Test" "MongoDb" "Iris" "AWSEC2" "AzureCompute" "GCE" "Nutanix" "Proxmox" "LinuxPhysicalPpc" "ApplicationBackupRepository"
platformIdFilter
string <uuid>

Filters restore points by ID of the backup object platform.

backupIdFilter
string <uuid>

Filters restore points by backup ID.

backupObjectIdFilter
string <uuid>

Filters restore points by backup object ID.

malwareStatusFilter
Array of strings (ESuspiciousActivitySeverity)

Filters restore points by malware status.

Items Enum: "Clean" "Suspicious" "Infected" "Informative"
typeFilter
Array of strings (ERestorePointType)

Filters restore points by restore point type.

Items Enum: "Increment" "Full" "Rollback" "Snapshot" "Cdp" "Different"
excludeSnapshotTypeFilter
Array of integers <int32>

Excludes restore points whose snapshot type matches any of the specified values.

header Parameters
x-api-version
required
string
Default: 1.3-rev2

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/restorePoints
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Restore Point
The HTTP GET request to the /api/v1/restorePoints/{id} endpoint gets a restore point that has the specified id.
 Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Restore point ID. To get the ID, run the Get All Restore Points request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/restorePoints/{id}
Request samples 
Response samples 
application/json
{
  • "platformName": "LinuxPhysical",
  • "type": "Increment",
  • "malwareStatus": "Clean",
  • "id": "ab3361d3-df80-474d-b23f-ea9a498b9e8c",
  • "name": "linbase02 AgentBackupJob",
  • "platformId": "00000000-0000-0000-0000-000000000000",
  • "creationTime": "2024-11-06T00:30:20+01:00",
  • "backupId": "00d9832b-0b4e-45fe-a284-0683e6c0e44c",
  • "allowedOperations": [
    ],
  • "backupFileId": "bfe4ce8a-a41e-4a86-aae6-1471fac1bb31"
}
Get Restore Point Disks
The HTTP GET request to the /api/v1/restorePoints/{id}/disks endpoint gets an array of disks from a restore point that has the specified id.
 Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Restore point ID. To get the ID, run the Get All Restore Points request.


 
query Parameters
skip
integer <int32> 
Number of items to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of items to return.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/restorePoints/{id}/disks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Restore Point Network Info
The HTTP POST request to the /api/v1/restorePoints/{id}/networkInfo path allows you to get an array of network interfaces from a restore point that has the specified id.
 Available to: Backup Administrator, Backup Operator, Restore Operator, Backup Viewer. Also available to custom roles that have backup or restore permissions.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Restore point ID. To get the ID, run the Get All Restore Points request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev2
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
object (PaginationFilter) 
Pagination settings.


 
object (FilterExpressionModel) 
Filter settings.


 
object (SortExpressionModel) 
Sorting settings.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/restorePoints/{id}/networkInfo
Request samples 
application/json
{
  • "pagination": {
    },
  • "filter": {
    },
  • "sorting": {
    }
}
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}