Veeam Backup & Replication 13
REST API Reference
Related documents

Replicas

The Replicas section defines paths and operations for managing snapshot replicas.

Get All Replicas

The HTTP GET request to the /api/v1/replicas path allows you to get an array of all replicas that are created on the backup server.

Available to: Veeam Backup Administrator, Veeam Restore Operator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of replicas to skip.

limit
integer <int32>
Default: 200

Maximum number of replicas to return.

orderColumn
string (EReplicasFiltersOrderColumn)

Sorts replicas by one of the replica parameters.

Enum: "Name" "CreationTime" "PlatformId" "JobId" "PolicyTag" "State"
orderAsc
boolean

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

nameFilter
string

Filters replicas by the nameFilter pattern. The pattern can match any replica parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.

createdAfterFilter
string <date-time>

Returns replicas that are created after the specified date and time.

createdBeforeFilter
string <date-time>

Returns replicas that are created before the specified date and time.

platformIdFilter
string <uuid>

Filters replicas by ID of the backup object platform.

jobIdFilter
string <uuid>

Filters replicas by ID of the parent job.

policyTagFilter
string

Filters replicas by retention policy unique ID.

stateFilter
string

Filters replicas by state.

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


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Replica ID. To get the ID, run the Get All Replicas 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/replicas/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "Regular",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "policyUniqueId": "string",
  • "name": "string",
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "state": "Ready"
}
Rescan Replicas
The HTTP POST request to the /api/v1/replicas/rescan path allows you to rescan replicas.
Available to: Veeam Backup Administrator, Veeam Restore Operator.


SecurityBearer 
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>.


 
Request Body schema: application/json
replicaIds
Array of strings <uuid> 
Array of replica IDs that you want to rescan. To get the IDs, run the Get All Replicas request.


 
Responses 
201
A ConfigurationResynchronize session has been created to rescan replicas. To check the progress, track the session state.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


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.


post/api/v1/replicas/rescan
Request samples 
application/json
{
  • "replicaPointIds": [
    ]
}
Response samples 
application/json
{
  • "sessionType": "ConfigurationResynchronize",
  • "state": "Stopped",
  • "id": "3491ffcf-082e-4a1c-8a2b-e77bd4d1c291",
  • "name": "Configuration Database Resynchronize",
  • "activityId": "3491ffcf-082e-4a1c-8a2b-e77bd4d1c291",
  • "creationTime": "2023-10-26T15:14:28.085236+02:00",
  • "endTime": "2023-10-26T15:14:33.679242+02:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": null,
  • "resourceReference": null,
  • "parentSessionId": null,
  • "usn": 0
}
Get All Replica Restore Points
The HTTP GET request to the /api/v1/replicas/{id}/replicaPoints path allows you to get an array of all replica restore points for a replica that has the specified id.
Available to: Veeam Backup Administrator, Veeam Restore Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Replica ID. To get the ID, run the Get All Replicas 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.


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


SecurityBearer 
Request 
path Parameters
replicaId
required
string <uuid> 
Replica ID. To get the ID, run the Get All Replicas request.


 
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/replicas/{replicaId}/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": [
    ]
}