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>
Default: 200

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

If true, 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.

jobTypeFilter
string (EJobType)

Filters backups by job type.

Enum: "Unknown" "VSphereBackup" "HyperVBackup" "VSphereReplica" "CloudDirectorBackup" "EntraIDTenantBackup" "EntraIDAuditLogBackup" "FileBackupCopy" "LegacyBackupCopy" "BackupCopy" "WindowsAgentBackup" "LinuxAgentBackup" "EntraIDTenantBackupCopy"
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/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> 
Backup ID. To get the ID, run the Get All Backups 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/backups/{id}
Request samples 
Response samples 
application/json
{
  • "platformName": "VMware",
  • "jobType": "VSphereBackup",
  • "id": "5a39b6d1-008c-4518-bb08-869221b61235",
  • "jobId": "02c7f07b-0fb0-4cd6-8601-3ddf1002b189",
  • "policyUniqueId": "02c7f07b-0fb0-4cd6-8601-3ddf1002b189",
  • "name": "PostgreSQL backup job",
  • "platformId": "00000000-0000-0000-0000-000000000000",
  • "creationTime": "2025-07-09T10:58:28.24213+02:00",
  • "repositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
  • "repositoryName": "Default Backup Repository"
}
Delete Backup
The HTTP DELETE request to the /api/v1/backups/{id} path allows you to delete a backup that has the specified id.
Available to: Veeam Backup Administrator.


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


 
query Parameters
fromDBIfSPUnavailable
boolean
(Only for Veeam Cloud Connect infrastructure) If true, Veeam Backup & Replication deletes the backup record from the configuration database if the service provider is not available (for example, if a cloud gateway is down, a cloud repository is not available, or the Cloud Connect license is expired).


 
includeGFS
boolean
If true, Veeam Backup & Replication also deletes the backups with GFS flags (weekly, monthly and yearly full backups).


 
fromDB
boolean
If true, Veeam Backup & Replication deletes only the record of the backup from the configuration database and keeps the backup in the backup repository.


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


delete/api/v1/backups/{id}
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": null,
  • "resourceReference": null,
  • "parentSessionId": null,
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
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 and Microsoft Hyper-V 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> 
Backup ID. To get the ID, run the Get All Backups 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/backups/{id}/objects
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Delete Backup Object
The HTTP DELETE request to the /api/v1/backups/{id}/objects/{objectId} path allows you to delete an infrastructure object (VM or VM container) 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.


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


 
objectId
required
string <uuid> 
Object ID. To get the ID, run the Get Backup Objects request.


 
query Parameters
fromDBIfSPUnavailable
boolean
(Only for Veeam Cloud Connect infrastructure) If true, Veeam Backup & Replication deletes the backup record from the configuration database if the service provider is not available (for example, if a cloud gateway is down, a cloud repository is not available, or the Cloud Connect license is expired).


 
includeGFS
boolean
If true, Veeam Backup & Replication also deletes the backups with GFS flags (weekly, monthly and yearly full backups).


 
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 
201
A DeleteBackup session has been created to delete the backup. To check the progress, track the session state.


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.


delete/api/v1/backups/{id}/objects/{objectId}
Request samples 
Response samples 
application/json
{
  • "sessionType": "ConfigurationBackup",
  • "state": "Stopped",
  • "id": "f848e90c-7f37-4ff5-9d55-04e33f8a4de3",
  • "name": "Backup Configuration Job",
  • "jobId": "99d1bf3d-e2e0-4bec-b2b3-820c0b87d212",
  • "creationTime": "2023-11-08T10:00:12.56+01:00",
  • "endTime": "2023-11-08T10:00:34.017+01:00",
  • "progressPercent": 100,
  • "result": {
    },
  • "resourceId": null,
  • "resourceReference": null,
  • "parentSessionId": null,
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "00000000-0000-0000-0000-000000000000"
}
Download Backup Metadata
The HTTP POST request to the /api/v1/backups/{id}/downloadBackupMeta path allows you to download metadata of a backup that has the specified id.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Backup ID. To get the ID, run the Get All Backups 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
optional
targetRepositoryId
string <uuid> 
ID of the repository where the backup metadata will be stored.


 
Responses 
201
An UnstructuredDownloadMeta session has been created to download the backup metadata. To check the progress, track the session state.


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/backups/{id}/downloadBackupMeta
Request samples 
application/json
{
  • "targetRepositoryId": "e5e3201d-c04e-4805-9432-f1a711ddba9f"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "sessionType": "Infrastructure",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "state": "Stopped",
  • "progressPercent": 0,
  • "result": {
    },
  • "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
  • "resourceReference": "string",
  • "parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
  • "usn": 0,
  • "platformName": "VMware",
  • "platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
  • "initiatedBy": "string"
}
Get All Backup Files
The HTTP GET request to the /api/v1/backups/{id}/backupFiles path allows you to get an array of all backup files in a backup that has the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.


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


 
query Parameters
skip
integer <int32> 
Number of backup files to skip.


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


 
orderColumn
string (EBackupFilesFiltersOrderColumn) 
Sorts backup files by one of the backup files parameters.


 Enum: "Name" "DataSize" "BackupSize" "DedupRatio" "CompressRatio" "CreationTime" "GFSPeriod"  
orderAsc
boolean
If true, sorts backup files in the ascending order by the orderColumn parameter.


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


 
createdAfterFilter
string <date-time> 
Returns backup files that are created after the specified date and time.


 
createdBeforeFilter
string <date-time> 
Returns backup files that are created before the specified date and time.


 
gfsPeriodFilter
string (EBackupFileGFSPeriod) 
Filters backup files by GFS period.


 Enum: "None" "Weekly" "Monthly" "Quarterly" "Yearly"  
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/backups/{id}/backupFiles
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Get Backup File
The HTTP GET request to the /api/v1/backups/{id}/backupFiles/{backupFileId} path allows you to get a backup file with the specified id.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Tape Operator, Veeam Backup Viewer.


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


 
backupFileId
required
string <uuid> 
Backup file ID. To get the ID, run the Get All Backup Files 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/backups/{id}/backupFiles/{backupFileId}
Request samples 
Response samples 
application/json
{
  • "id": "bfe4ce8a-a41e-4a86-aae6-1471fac1bb31",
  • "name": "C:\\Backup\\SRV99_Administrator\\linbase02 AgentBackupJob\\AgentBackupJob_2024-11-06T003020.vib",
  • "backupId": "00d9832b-0b4e-45fe-a284-0683e6c0e44c",
  • "objectId": "00000000-0000-0000-0000-000000000000",
  • "restorePointIds": [
    ],
  • "dataSize": 1203845162,
  • "backupSize": 520585216,
  • "dedupRatio": 81,
  • "compressRatio": 53,
  • "creationTime": "2024-11-06T00:30:20",
  • "gfsPeriods": [
    ]
}