Veeam Backup & Replication 13
REST API Reference
Related documents

Backup Objects

The Backup Objects section defines paths and operations for managing backup objects — VMs and vApps that are included in backups created by the backup server.

Types of backup objects differ depending on the backup job platform:

  • Backups of VMware vSphere jobs contain VMs only.
  • Backups of VMware Cloud Director jobs contain VMs and vApps.

Get All Backup Objects

The HTTP GET request to the /api/v1/backupObjects endpoint gets an array of virtual infrastructure objects (VMs and VM containers) that are included in backups created by the backup server.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of backup objects to skip.

limit
integer <int32>
Default: 200

Maximum number of backup objects to return.

orderColumn
string (EBackupObjectsFiltersOrderColumn)

Sorts backup objects by one of the backup object parameters.

Enum: "Name" "ObjectId" "PlatformId" "Type"
orderAsc
boolean

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

nameFilter
string

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

platformNameFilter
string (EPlatformType)

Filters backup objects by platform ID.

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

Filters backup objects by platform ID.

typeFilter
string

Filters backup objects by object type.

viTypeFilter
string

Filters backup objects by the type of VMware vSphere server.

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

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/backupObjects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Backup Object
The HTTP GET request to the /api/v1/backupObjects/{id} endpoint gets a backup object that has the specified id. 
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup object ID. To get the ID, run the Get Backup Objects request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/backupObjects/{id}
Request samples 
Response samples 
application/json
{
  • "viType": "VirtualMachine",
  • "objectId": "vm-69191",
  • "path": "vcenter01.tech.local\\Atlanta\\esx04.tech.local\\Enterprise\\winsrv88",
  • "platformName": "VmWare",
  • "id": "fcea73fa-aa48-45e1-89e4-6e33411e8de2",
  • "name": "winsrv88",
  • "type": "VM",
  • "platformId": "00000000-0000-0000-0000-000000000000",
  • "restorePointsCount": 13
}
Create Recovery Media for Backup Object
The HTTP GET request to the /api/v1/backupObjects/{id}/createRecoveryMedia endpoint creates Veeam Recovery Media for a backup created by Veeam Agent for Microsoft Windows. The request will create an ISO file that you can boot from in case the computer stops working or the hard disk fails.
 You can also create Veeam Recovery Media for a computer in a protection group. For more information, see Create Recovery Media for Discovered Entity. 
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup object ID. To get the ID, run the Get Backup Objects request.


 
query Parameters
format
required
string (ERecoveryMediaFormat) 
Recovery media format.


 Value: "Iso"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/backupObjects/{id}/createRecoveryMedia
Request samples 
Response samples 
application/json
{
  • "errorCode": "AccessDenied",
  • "message": "string",
  • "resourceId": "string"
}
Get Restore Points
The HTTP GET request to the /api/v1/backupObjects/{id}/restorePoints endpoint gets an array of restore points of a backup object that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup object ID. To get the ID, run the Get Backup Objects 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 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 name of the backup object platform.


 Enum: "VMware" "HyperV" "CloudDirector" "WindowsPhysical" "LinuxPhysical" "Tape" "CustomPlatform" "EntraID" "UnstructuredData" "Test" "MongoDb" "AWSEC2" "AzureCompute" "GCE"  
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
string (ESuspiciousActivitySeverity) 
Filters restore points by malware status.


 Enum: "Clean" "Suspicious" "Infected" "Informative"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/backupObjects/{id}/restorePoints
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}