Veeam ONE 13
REST API Reference
Related documents

Veeam Backup & Replication Protected Data

This resource collection represents protected workloads in the monitored Veeam Backup & Replication infrastructures.

Get All Protected VMs

Returns a collection resource representation of all protected VMs.

SecurityBearer
Request
query Parameters
Offset
integer <int32>
Default: 0
Limit
integer <int32>
Default: 100
Filter
string
Sort
string
Select
string
Responses
200

Success

403

Forbidden

get/api/v2.3/protectedData/virtualMachines
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Protected VM
Returns a resource representation of a protected VM with the specified UID.


SecurityBearer 
Request 
path Parameters
vmUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/virtualMachines/{vmUidInVbr}
Request samples 
Response samples 
application/json
{
  • "vmId": null,
  • "vmUidInVbr": "385958a9-b88f-4992-8020-00ddfcb2e2e3",
  • "vmIdInHypervisor": "d56e070b-c90e-4f2d-80ed-3df847a5d200",
  • "backupServerId": 11724,
  • "backupServerName": "vbr1.tech.local",
  • "name": "VM3 VeeamONE",
  • "platform": "NutanixAhv",
  • "parentHostName": "172.24.16.223",
  • "ipAddresses": [ ],
  • "usedSourceSizeBytes": 0,
  • "provisionedSourceSizeBytes": 0,
  • "lastProtectedDate": "2022-11-01T23:12:10Z",
  • "jobUid": "0bd049fb-f1db-47fc-8d8e-83f6968f8bb9",
  • "jobName": "Backup Job 2"
}
Get Backups of All Protected VMs
Returns a collection resource representation of all backups of protected VMs.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/virtualMachines/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Backups of Protected VM
Returns a collection resource representation of all backups of a protected VM with the specified UID.


SecurityBearer 
Request 
path Parameters
vmUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/virtualMachines/{vmUidInVbr}/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Backup Restore Points of Protected VM
Returns a collection resource representation of restore points created for a protected VM with the specified UID.


SecurityBearer 
Request 
path Parameters
vmUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/virtualMachines/{vmUidInVbr}/backupRestorePoints
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Replication Restore Points of Protected VM
Returns a collection resource representation of replication restore points created for a protected VM with the specified UID.


SecurityBearer 
Request 
path Parameters
vmUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/virtualMachines/{vmUidInVbr}/replicaRestorePoints
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Protected Computers
Returns a collection resource representation of all protected computers.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/computers
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Protected Computer
Returns a resource representation of a protected computer with the specified UID.


SecurityBearer 
Request 
path Parameters
computerUidInVbr
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/computers/{computerUidInVbr}
Request samples 
Response samples 
application/json
{
  • "computerId": 11748,
  • "computerUidInVbr": "8d1b5f02-a4a9-4483-8142-d2540ad39c85",
  • "backupServerId": 11724,
  • "backupServerName": "ms-win22.tech.local",
  • "protectionGroups": [
    ],
  • "name": "win16-1.tech.local",
  • "ipAddresses": [
    ],
  • "platform": "MicrosoftWindows",
  • "operationMode": "Server",
  • "lastProtectedDate": "2025-07-17T14:51:58.977Z"
}
Get Backups of All Protected Computers
Returns a collection resource representation of backups of all protected computers.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/computers/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get All Backups of Protected Computer
Returns a collection resource representation of all backups of a protected computer with the specified UID.


SecurityBearer 
Request 
path Parameters
computerUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/computers/{computerUidInVbr}/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Backup Restore Points of Protected Computer
Returns a collection resource representation of all backup restore points created for a computer with the specified UID.


SecurityBearer 
Request 
path Parameters
computerUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/computers/{computerUidInVbr}/backupRestorePoints
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Protected File Shares
Returns a collection resource representation of all protected file shares.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/fileShares
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Protected File Share
Returns a resource representation of a protected file share with the specified UID.


SecurityBearer 
Request 
path Parameters
fileShareUidInVbr
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/fileShares/{fileShareUidInVbr}
Request samples 
Response samples 
application/json
{
  • "fileShareUidInVbr": "ac1ba942-5b16-40f6-84da-0405d71315a8",
  • "name": "pdc-ontap97-1\\nas:/ag_vol",
  • "backupServerId": 11782,
  • "backupServerName": "ms-win22.tech.local",
  • "type": "SanNfsServer",
  • "jobUids": [
    ],
  • "lastProtectedDate": "2025-07-08T19:15:11Z"
}
Get Backups of All Protected File Shares
Returns a collection resource representation of backups of all protected file shares.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/fileShares/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Backups of Protected File Share
Returns a collection resource representation of all backups of a protected file share with the specified UID.


SecurityBearer 
Request 
path Parameters
fileShareUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/fileShares/{fileShareUidInVbr}/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Backup Restore Points of Protected File Share
Returns a collection resource representation of backup restore points created for a protected file share with the specified UID.


SecurityBearer 
Request 
path Parameters
fileShareUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/fileShares/{fileShareUidInVbr}/backupRestorePoints
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Protected Object Storages
Returns a collection resource representation of all protected object storages.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/objectStorages
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Protected Object Storage
Returns a resource representation of a protected object storage with the specified UID.


SecurityBearer 
Request 
path Parameters
objectStorageUidInVbr
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/objectStorages/{objectStorageUidInVbr}
Request samples 
Response samples 
application/json
{
  • "objectStorageUidInVbr": "6958d49c-9eab-4ecf-81bb-83014383f42f",
  • "name": "s3comp",
  • "backupServerId": 5,
  • "backupServerName": "ol-win19.tech.local",
  • "type": "S3Compatible",
  • "jobs": [
    ],
  • "lastProtectedDate": "2023-10-05T06:50:10Z"
}
Get Backups of All Protected Object Storages
Returns a collection resource representation of backups of all protected object storages.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/objectStorages/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Backups of Protected Object Storage
Returns a collection resource representation of all backups of a protected object storage with the specified UID.


SecurityBearer 
Request 
path Parameters
objectStorageUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/objectStorages/{objectStorageUidInVbr}/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Backup Restore Points of Protected Object Storage
Returns a collection resource representation of backup restore points created for a protected object storage with the specified UID.


SecurityBearer 
Request 
path Parameters
objectStorageUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/unstructuredData/objectStorages/{objectStorageUidInVbr}/backupRestorePoints
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Protected Applications
Returns a collection resource representation of all protected applications.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/applications
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Protected Application
Returns a resource representation of a protected application with the specified UID.


SecurityBearer 
Request 
path Parameters
applicationUidInVbr
required
string <uuid> 
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/applications/{applicationUidInVbr}
Request samples 
Response samples 
application/json
{
  • "applicationUidInVbr": "67878b78-beb9-435f-8dd8-af1a21f1a4c3",
  • "backupServerId": 11702,
  • "backupServerName": "ol-win19.tech.local",
  • "name": "pgSLESk",
  • "platform": "SapHana",
  • "processedDatabases": 2,
  • "notProcessedDatabases": 0,
  • "protectionGroups": [
    ],
  • "lastProtectedDate": "2025-07-17T15:22:28.78Z"
}
Get Backups of All Application Databases
Returns a collection resource representation of backups of application databases.


SecurityBearer 
Request 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/applications/databases/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Database Backups of Application
Returns a collection of all backups protecting databases of an application with the specified UID.


SecurityBearer 
Request 
path Parameters
applicationUidInVbr
required
string <uuid> 
 
query Parameters
Offset
integer <int32> 
 Default:  0
 
Limit
integer <int32> 
 Default:  100
 
Filter
string
 
Sort
string
 
Select
string
 
Responses 
200
Success


403
Forbidden


get/api/v2.3/protectedData/applications/{applicationUidInVbr}/databases/backups
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}

    
    

                                

                                    
Document updated 9/08/2025
Page content applies to build 13.0.0.5630