Veeam Backup & Replication 13
REST API Reference
Related documents

Replica Restore Points

The Replica Restore Points section defines paths and operations for managing restore points of snapshot replicas.

Get All Replica Restore Points

The HTTP GET request to the /api/v1/replicaPoints path allows you to get an array of all replica restore points created on the backup server.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

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 (EReplicaRestorePointsFiltersOrderColumn)

Sorts restore points by one of the restore point parameters.

Enum: "CreationTime" "PlatformId" "ReplicaId" "Name"
orderAsc
boolean

If true, sorts restore points in the 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 replica platform name.

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

Filters restore points by replica platform ID.

replicaIdFilter
string <uuid>

Filters restore points by replica ID.

malwareStatusFilter
string (ESuspiciousActivitySeverity)

Filters restore points by malware status.

Enum: "Clean" "Suspicious" "Infected" "Informative"
header Parameters
x-api-version
required
string
Default: 1.3-rev0

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/replicaPoints
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Replica Restore Point
The HTTP GET request to the /api/v1/replicaPoints/{id} path allows you to get a replica restore point that has the specified id.
Available to: Veeam Backup Administrator, Veeam Restore Operator.


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


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
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/replicaPoints/{id}
Request samples 
Response samples 
application/json
{
  • "platformName": "VMware",
  • "state": "Ready",
  • "malwareStatus": "Clean",
  • "id": "f2d8dc48-dd3b-42c0-aa18-40c14424876d",
  • "name": "ubuntu88",
  • "platformId": "00000000-0000-0000-0000-000000000000",
  • "creationTime": "2023-10-26T15:39:53.754085+02:00",
  • "replicaId": "e7c0ef09-8bd4-4cbd-b26a-2fd0177e6b0c",
  • "allowedOperations": [
    ]
}