Veeam Backup & Replication 13
REST API Reference
Related documents

Backups

The Backups section defines paths and operations for managing backups that are created on or imported to the backup server.

Get All Backups

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

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

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of backups to skip.

limit
integer <int32>

Maximum number of backups to return.

orderColumn
string (EBackupsFiltersOrderColumn)

Sorts backups by one of the backup parameters.

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

Sorts backups in the ascending order by the orderColumn parameter.

nameFilter
string

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

createdAfterFilter
string <date-time>

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

createdBeforeFilter
string <date-time>

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

platformIdFilter
string <uuid>

Filters backups by ID of the backup object platform.

jobIdFilter
string <uuid>

Filters backups by ID of the parent job.

policyTagFilter
string

Filters backups by retention policy tag.

header Parameters
x-api-version
required
string
Default: 1.1-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/backups
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Backup
The HTTP GET request to the /api/v1/backups/{id} path allows you to get a backup 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> 
ID of the backup.


 
header Parameters
x-api-version
required
string
 Default:  1.1-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/backups/{id}
Request samples 
Response samples 
application/json
{
  • "platformName": "VMware",
  • "id": "9d4c348d-284a-480d-9340-6454998fa227",
  • "jobId": "301450bc-34cd-4d2c-bfc3-8d269bb471be",
  • "policyUniqueId": "",
  • "name": "AD Backup",
  • "platformId": "00000000-0000-0000-0000-000000000000",
  • "creationTime": "2021-02-12T04:24:32.087+03:00",
  • "repositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec"
}
Get Backup Objects
The HTTP GET request to the /api/v1/backups/{id}/objects path allows you to get an array of virtual infrastructure objects (VMs and VM containers) that are included in a backup that has the specified ID. 
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.
 
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> 
ID of the backup.


 
header Parameters
x-api-version
required
string
 Default:  1.1-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/backups/{id}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}