- About Veeam ONE REST API
- Overview
- Changelog
- About
- Alarms
- Authentication
- Business View
- Licensing
- Microsoft Hyper-V Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Microsoft Hyper-V VMs
- getGet Microsoft Hyper-V VM
- getGet All Microsoft Hyper-V Host Clusters
- getGet Microsoft Hyper-V Host Cluster
- getGet All Microsoft Hyper-V CSVs
- getGet Microsoft Hyper-V CSV
- getGet All Microsoft Hyper-V Host Groups
- getGet Microsoft Hyper-V Host Group
- getGet All Microsoft Hyper-V Hosts
- getGet Microsoft Hyper-V Host
- getGet All Microsoft Hyper-V Physical Disks
- getGet Microsoft Hyper-V Physical Disk
- getGet All Microsoft Hyper-V SCVMM Servers
- getGet Microsoft Hyper-V SCVMM Server
- getGet All Microsoft Hyper-V File Servers
- getGet Microsoft Hyper-V File Server
- getGet All Microsoft Hyper-V File Shares
- getGet Microsoft Hyper-V File Share
- Public Cloud
- getGet All Cloud VM Policies.
- getGet Cloud VM Policy
- getGet All Cloud File Share Policies
- getGet Cloud File Share Policy
- getGet All Cloud Database Policies
- getGet Cloud Database Policy
- getGet All Public Cloud Network Policies
- getGet Public Cloud Network Policy
- getGet All Cloud VMs
- getGet All Cloud File Shares
- getGet All Cloud Databases
- Public Cloud Protected Data
- getGet All Protected Cloud VMs
- getGet Protected Cloud VM
- getGet Backups of All Protected Cloud VMs
- getGet All Backups of Protected Cloud VM
- getGet All Restore Points of Protected Cloud VM
- getGet All Protected Cloud File Shares
- getGet Protected Cloud File Share
- getGet Backups of All Protected Cloud File Shares
- getGet All Backups of Protected Cloud File Share
- getGet All Restore Points of Protected Cloud File Share
- getGet All Protected Cloud Databases
- getGet Protected Cloud Database
- getGet Backups of All Protected Cloud Databases
- getGet All Backups of Protected Cloud Database
- getGet All Restore Points of Protected Cloud Database
- getGet All Protected Cloud Networks
- getGet Protected Cloud Network
- getGet All Cloud Network Backups
- getGet Backups of Cloud Network
- getGet Restore Points of Cloud Network
- Task Sessions
- VMware Cloud Director Infrastructure
- getGet Infrastucture Object Relations
- getGet Relations of Infrastructure Object
- getGet All Organizations
- getGet Organization
- getGet All Organization VDCs
- getGet Organization VDC
- getGet All Provider VDCs
- getGet Provider VDC
- getGet All Provider VDC Datastores
- getGet Provider VDC Datastore
- getGet All vApps
- getGet vApp
- getGet All VMs in vApps
- getGet All VMs in vApp
- getGet All VMware Cloud Director Servers
- getGet VMware Cloud Director Server
- VMware vSphere Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All vCenter Servers
- getGet vCenter Server
- getGet All VMware vSphere VMs
- getGet VMware vSphere VM
- getGet All VMware vSphere Host Clusters
- getGet Host Cluster
- getGet All VMware vSphere Datastores
- getGet VMware vSphere Datastore
- getGet All VMware vSphere Hosts
- getGet VMware vSphere Host
- getGet All Host Hardware Sensors
- getGet Hardware Sensors of Host
- getGet All Resource Pools
- getGet Resource Pool
- getGet All Datastore Clusters
- getGet Datastore Cluster
- getGet All vApps
- getGet vApp
- getGet All VMware vSphere VM Folders
- getGet VMware vSphere VM Folder
- Veeam Backup & Replication Failover Plans
- Veeam Backup & Replication Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Backup Agents
- getGet Backup Agent
- getGet All Veeam Backup & Replication Servers
- getGet Veeam Backup & Replication Server
- getGet All Best Practices
- getGet Best Practices for Veeam Backup & Replication Server
- getGet All Backup Proxies
- getGet Backup Proxy
- getGet All WAN Accelerators
- getGet WAN Accelerator
- getGet All Tape Servers
- getGet Tape Server
- getGet All Veeam Backup Enterprise Manager Servers
- getGet Veeam Backup Enterprise Manager Server
- getGet All Backup Repositories
- getGet Backup Repository
- getGet All External Backup Repositories
- getGet External Backup Repository
- getGet All Object Storage Repositories
- getGet Object Storage Repository
- getGet All Scale-Out Repositories
- getGet Scale-Out Repository
- getGet All Performance Tier Extents
- getGet Performance Tier Extent
- getGet All Archive Tier Extents
- getGet Archive Tier Extent
- getGet All Capacity Tier Extents
- getGet Capacity Tier Extent
- getGet All Connected Applications
- getGet Connected Application
- Veeam Backup & Replication Jobs
- getGet All VM Backup Jobs
- getGet VM Backup Job
- getGet All VMware Cloud Director Backup Jobs
- getGet VMware Cloud Director Backup Job
- getGet All VM Replication Jobs
- getGet VM Replication Job
- getGet All VMware Cloud Director Replication Jobs
- getGet VMware Cloud Director Replication Job
- getGet All Backup to Tape Jobs
- getGet Backup to Tape Job
- getGet All Backup Copy Jobs
- getGet Backup Copy Job
- getGet All Child Jobs of Backup Copy Job
- getGet All SureBackup Jobs
- getGet SureBackup Job
- getGet All VM Copy Jobs
- getGet VM Copy Job
- getGet All Snapshot-Only Jobs
- getGet Snapshot-Only Job
- getGet All CDP Policies
- getGet CDP Policy
- getGet All File to Tape Jobs
- getGet File to Tape Job
- getGet All Object to Tape Jobs
- getGet Object to Tape Job
- getGet All File Copy Jobs
- getGet File Copy Job
- getGet All File Backup Jobs
- getGet File Backup Job
- getGet All Agent Backup Jobs
- getGet Agent Backup Job
- getGet All Veeam Backup Agent Policies
- getGet Veeam Backup Agent Policy
- getGet All Veeam Backup Agent Policy Child Jobs
- getGet All Application Backup Jobs
- getGet Application Backup Job
- getGet All Enterprise Application Transaction Log Backup Jobs
- getGet Enterprise Application Transaction Log Backup Job
- getGet All Transaction Log Backup Jobs
- getGet Transaction Log Backup Job
- getGet All Object Storage Jobs
- getGet Object Storage Job
- Veeam Backup & Replication Protected Data
- getGet All Protected VMs
- getGet Protected VM
- getGet Backups of All Protected VMs
- getGet Backups of Protected VM
- getGet All Backup Restore Points of Protected VM
- getGet All Replication Restore Points of Protected VM
- getGet All Protected Computers
- getGet Protected Computer
- getGet Backups of All Protected Computers
- getGet All Backups of Protected Computer
- getGet All Backup Restore Points of Protected Computer
- getGet All Protected File Shares
- getGet Protected File Share
- getGet Backups of All Protected File Shares
- getGet Backups of Protected File Share
- getGet All Backup Restore Points of Protected File Share
- getGet All Protected Object Storages
- getGet Protected Object Storage
- getGet Backups of All Protected Object Storages
- getGet Backups of Protected Object Storage
- getGet All Backup Restore Points of Protected Object Storage
- getGet All Protected Applications
- getGet Protected Application
- getGet Backups of All Application Databases
- getGet All Database Backups of Application
- Veeam Backup for Microsoft 365 Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Veeam Backup for Microsoft 365 Servers
- getGet Veeam Backup for Microsoft 365 Server
- getGet All Proxy Pools
- getGet Backup Proxy Pool
- getGet All Veeam Backup for Microsoft 365 Backup Proxy Servers
- getGet Veeam Backup for Microsoft 365 Backup Proxy Server
- getGet All Veeam Backup for Microsoft 365 Backup Repositories
- getGet Veeam Backup for Microsoft 365 Backup Repository
- getGet All Veeam Backup for Microsoft 365 Object Storage Repositories
- getGet Veeam Backup for Microsoft 365 Object Storage Repository
- getGet All Microsoft Organizations
- getGet Microsoft Organization
- getGet All Users of Microsoft Organization
- getGet Microsoft 365 User
- getGet All Microsoft 365 Users
- getGet All Groups of Microsoft Organization
- getGet Microsoft 365 Group
- getGet All Microsoft 365 Groups
- getGet SharePoint Sites of Microsoft Organization
- getGet Microsoft SharePoint Site
- getGet All Microsoft SharePoint Sites
- getGet All Teams of Microsoft Organization
- getGet Microsoft 365 Team
- getGet All Microsoft 365 Teams
- Veeam Backup for Microsoft 365 Jobs
- Veeam Backup for Microsoft 365 Protected Data
- getGet All Protected Microsoft 365 Users
- getGet Restore Points of All Protected Microsoft 365 Users
- getGet Protected Microsoft 365 User
- getGet All Microsoft 365 User Restore Points
- getGet All Protected Microsoft 365 Groups
- getGet Restore Points of All Protected Microsoft 365 Groups
- getGet Protected Microsoft 365 Group
- getGet All Microsoft 365 Group Restore Points
- getGet All Protected Microsoft 365 Sites
- getGet Restore Points of All Protected Microsoft 365 Sites
- getGet Protected Microsoft 365 Site
- getGet All Microsoft 365 Site Restore Points
- getGet All Protected Microsoft 365 Teams
- getGet Restore Points of All Protected Microsoft 365 Teams
- getGet Protected Microsoft 365 Team
- getGet All Microsoft 365 Team Restore Points
- Veeam Cloud Connect
This resource collection represents all jobs configured in the monitored Veeam Backup & Replication infrastructure.
Get All VM Backup Jobs
Returns a collection resource representation of all VM backup jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "vmBackupJobUid": "a1b77dfa-4845-4063-8275-f3f683eb31db",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "DefaultBackupJob",
- "description": "DefaultBackupJob",
- "platform": "VSphere",
- "lastRun": "2025-07-10T05:27:46.507Z",
- "lastRunDurationSec": 70,
- "avgDurationSec": 70,
- "lastTransferredDataBytes": 32
}, - {
- "vmBackupJobUid": "f492cec0-9ef9-4a44-b14d-07bacf521d0e",
- "backupServerId": 7199,
- "status": "Success",
- "details": [ ],
- "name": "Backup Job ol vms [2]",
- "description": "Created by VBR\\administrator at 7/10/2023 11:27 AM.",
- "platform": "VSphere",
- "lastRun": "2023-07-10T07:29:11.047Z",
- "lastRunDurationSec": 845,
- "avgDurationSec": 845,
- "lastTransferredDataBytes": 20299912983
}
], - "totalCount": 2
}
Get VM Backup Job
Returns a resource representation of a VM backup job with the specified UID.
path Parameters
vmBackupJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "vmBackupJobUid": "9138ba20-a489-4e44-980f-05eb7fa992e2",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "123",
- "description": "Created by administrator at 8/18/2022 00:42.",
- "platform": "VSphere",
- "lastRun": "2022-11-24T17:52:50.883Z",
- "lastRunDurationSec": 331,
- "avgDurationSec": 331,
- "lastTransferredDataBytes": 1698584149
}
Get All VMware Cloud Director Backup Jobs
Returns a collection resource representation of all jobs protecting VMware Cloud Director objects.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "cloudDirectorBackupJobUid": "d4eed6a7-fd29-44f9-98c4-327281f7cc79",
- "backupServerId": 11724,
- "status": "Success",
- "details": [ ],
- "name": "Backup Job 2 vcd",
- "description": "Created by administrator at 10/21/2022 5:40 AM.",
- "lastRun": null,
- "lastRunDurationSec": null,
- "avgDurationSec": null,
- "lastTransferredDataBytes": null
}, - {
- "cloudDirectorBackupJobUid": "d041cfc8-78d3-44ee-9536-bea28684678e",
- "backupServerId": 11782,
- "status": "Failed",
- "details": [
- "Task failed. Error: vCloud Director server is not accessible.",
- "Processing finished with errors at 10/24/2023 7:31:42 PM",
- "Job finished with error at 10/24/2023 7:31:46 PM",
- "Error: Your service provider's license key has expired."
], - "name": "CD Backup Job",
- "description": "Created by adm-1 at 12/9/2021 12:54 PM.",
- "lastRun": "2023-10-24T19:31:46.487Z",
- "lastRunDurationSec": 24,
- "avgDurationSec": 71,
- "lastTransferredDataBytes": 0
}, - {
- "cloudDirectorBackupJobUid": "9beef001-fb11-4378-ad71-cf021fda068f",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "VMware Cloud Director Backup Job to CC",
- "description": "Created by adm-1 at 12/9/2021 12:58 PM.",
- "lastRun": "2025-07-09T16:32:23.887Z",
- "lastRunDurationSec": 11,
- "avgDurationSec": 87,
- "lastTransferredDataBytes": 186045
}
], - "totalCount": 3
}
Get VMware Cloud Director Backup Job
Returns a resource representation of a VMware Cloud Director job with the specified UID.
path Parameters
cloudDirectorBackupJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "cloudDirectorBackupJobUid": "d4eed6a7-fd29-44f9-98c4-327281f7cc79",
- "backupServerId": 11724,
- "status": "Success",
- "details": [ ],
- "name": "Backup Job 2 vcd",
- "description": "Created by administrator at 10/21/2022 5:40 AM.",
- "lastRun": "2023-10-24T19:31:46.487Z",
- "lastRunDurationSec": 24,
- "avgDurationSec": 71,
- "lastTransferredDataBytes": 186045
}
Get All VM Replication Jobs
Returns a collection resource representation of all VM replication jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "vmReplicationJobUid": "b1b8ae82-def3-4797-bace-10f345576c5e",
- "backupServerId": 7199,
- "status": "Warning",
- "details": [
- "One or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues",
- "Processing finished with warnings at 10/29/2023 2:33:52 PM",
- "Job finished with warning at 10/29/2023 2:34:00 PM "
], - "name": "rr",
- "description": "Created by VBR\\administrator at 10/27/2023 10:39 AM.",
- "platform": "VSphere",
- "lastRun": "2023-10-29T10:31:06.693Z",
- "lastRunDurationSec": 173,
- "avgDurationSec": 180,
- "lastTransferredDataBytes": 32
}, - {
- "vmReplicationJobUid": "cae1a602-6f00-4367-b4de-4082956b098f",
- "backupServerId": 7843,
- "status": "Success",
- "details": [ ],
- "name": "Replication Job 3 hv",
- "description": "Created by VBR\\administrator at 10/24/2022 2:32 AM.",
- "platform": "HyperV",
- "lastRun": "2025-07-15T03:00:38.55Z",
- "lastRunDurationSec": 259,
- "avgDurationSec": 57,
- "lastTransferredDataBytes": 0
}
], - "totalCount": 2
}
Get VM Replication Job
Returns a resource representation of a VM replication job with the specified UID.
path Parameters
vmReplicationJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "vmReplicationJobUid": "cae1a602-6f00-4367-b4de-4082956b098f",
- "backupServerId": 7843,
- "status": "Success",
- "details": [ ],
- "name": "Replication Job 3 hv",
- "description": "Created by VBR\\administrator at 10/24/2022 2:32 AM.",
- "platform": "HyperV",
- "lastRun": "2025-07-15T03:00:38.55Z",
- "lastRunDurationSec": 259,
- "avgDurationSec": 57,
- "lastTransferredDataBytes": 0
}
Get All VMware Cloud Director Replication Jobs
Returns a collection resource representation of all replication jobs protecting VMware Cloud Director objects.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "cloudDirectorReplicationJobUid": "be65e529-d69f-453a-93f9-ce529eb87daa",
- "backupServerId": 11724,
- "status": "Warning",
- "details": [
- "Job finished with warning at 10/16/2023 11:09:36 PM ",
- "Processing km-vapp1"
], - "name": "Replication Job 2 vcd",
- "description": "Created by administrator at 10/11/2023 4:09 AM.",
- "lastRun": "2023-10-16T23:09:36.07Z",
- "lastRunDurationSec": 264,
- "avgDurationSec": 231,
- "lastTransferredDataBytes": 0
}, - {
- "cloudDirectorReplicationJobUid": "d041cfc8-78d3-44ee-9536-bea28684678e",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "VCD Replication Job",
- "description": "Created by adm-1 at 11/9/2023 12:54 PM.",
- "lastRun": "2023-03-07T17:33:02.487Z",
- "lastRunDurationSec": 247,
- "avgDurationSec": 251,
- "lastTransferredDataBytes": 23474
}, - {
- "cloudDirectorReplicationJobUid": "be65e529-d69f-453a-93f9-ce529eb87daa",
- "backupServerId": 7843,
- "status": "Warning",
- "details": [ ],
- "name": "Replication Job 2 vcd",
- "description": "Created by VBR\\administrator at 10/24/2022 4:09 AM.",
- "lastRun": null,
- "lastRunDurationSec": null,
- "avgDurationSec": null,
- "lastTransferredDataBytes": null
}
], - "totalCount": 3
}
Get VMware Cloud Director Replication Job
Returns a collection resource representation of all replication jobs protecting VMware Cloud Director objects.
path Parameters
cloudDirectorReplicationJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "cloudDirectorReplicationJobUid": "be65e529-d69f-453a-93f9-ce529eb87daa",
- "backupServerId": 11724,
- "status": "Warning",
- "details": [
- "Job finished with warning at 10/16/2023 11:09:36 PM ",
- "Processing km-vapp1"
], - "name": "Replication Job 2 vcd",
- "description": "Created by administrator at 10/11/2023 4:09 AM.",
- "lastRun": "2023-10-16T23:09:36.07Z",
- "lastRunDurationSec": 264,
- "avgDurationSec": 231,
- "lastTransferredDataBytes": 0
}
Get All Backup to Tape Jobs
Returns a collection resource representation of all backup to tape jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "backupToTapeJobUid": "16c354f2-2a53-4016-940a-2349428cb58e",
- "backupServerId": 11724,
- "status": "Success",
- "details": [ ],
- "name": "Backup to Tape Job 1",
- "description": "Created by administrator at 10/26/2023 12:49 AM.",
- "lastRun": "2025-07-22T21:56:54.073Z",
- "lastRunDurationSec": 259277,
- "avgDurationSec": 259277,
- "lastTransferredDataBytes": 8046104924
}, - {
- "backupToTapeJobUid": "269258e0-5192-4719-984d-2927a0415aea",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "PG Tape Job GFS",
- "description": "Created by administrator at 09/02/2023 18:45.",
- "lastRun": "2025-07-09T23:00:51.76Z",
- "lastRunDurationSec": 771,
- "avgDurationSec": 771,
- "lastTransferredDataBytes": 19526480453
}, - {
- "backupToTapeJobUid": "8fe6d6d2-66a0-43e0-87be-2d36b5baefbd",
- "backupServerId": 11782,
- "status": "Failed",
- "details": [ ],
- "name": "VM Backup copy to Tape Job",
- "description": "Created by adm-1 at 10/29/2023 6:49 PM.",
- "lastRun": null,
- "lastRunDurationSec": null,
- "avgDurationSec": null,
- "lastTransferredDataBytes": null
}
], - "totalCount": 3
}
Get Backup to Tape Job
Returns a resource representation of a backup to tape job with the specified UID.
path Parameters
backupToTapeJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "backupToTapeJobUid": "269258e0-5192-4719-984d-2927a0415aea",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "PG Tape Job GFS",
- "description": "Created by administrator at 09/02/2023 18:45.",
- "lastRun": "2025-07-09T23:00:51.76Z",
- "lastRunDurationSec": 771,
- "avgDurationSec": 771,
- "lastTransferredDataBytes": 19526480453
}
Get All Backup Copy Jobs
Returns a collection resource representation of all backup copy jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "backupCopyJobUid": "c9801c41-c0f6-425f-a8c4-001844152b8a",
- "backupServerId": 7843,
- "status": "Success",
- "details": [ ],
- "name": "Backup Copy Job 1 vm",
- "description": "Created by VBR\\administrator at 10/21/2022 5:15 AM.",
- "lastRun": "2025-07-13T14:05:10.383Z"
}, - {
- "backupCopyJobUid": "aeb1f22b-2da7-4ada-ac4d-01574a06466e",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Backup Copy Job 3",
- "description": "Created by VBR\\administrator at 10/11/2023 5:35 AM.",
- "lastRun": "2025-07-11T12:43:32.287Z"
}
], - "totalCount": 2
}
Get Backup Copy Job
Returns a resource representation of a backup copy job.
path Parameters
backupCopyJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "backupCopyJobUid": "aeb1f22b-2da7-4ada-ac4d-01574a06466e",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Backup Copy Job 3",
- "description": "Created by VBR\\administrator at 10/11/2023 5:35 AM.",
- "lastRun": "2025-07-11T12:43:32.287Z"
}
Get All Child Jobs of Backup Copy Job
Returns a collection resource representation of all child jobs of a backup copy job with the specified UID.
path Parameters
backupCopyJobUid required | string <uuid> |
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "childJobUid": "602ac34a-fd0b-4da2-8933-626e6abfc6e3",
- "name": "DefaultCopyJob\\DefaultBackupJob",
- "parentJobUid": "5d036027-3680-4057-8fe5-004f1c61484d",
- "backupServerId": 5,
- "status": "Success",
- "lastRun": "2025-07-10T06:42:14.477Z",
- "lastRunDurationSec": 136,
- "avgDurationSec": 136,
- "lastTransferredDataBytes": 32
}, - {
- "childJobUid": "51cc53f0-debd-4c19-ab87-6dd78b6d0705",
- "name": "Backup Copy Job 1 vm\\Backup Job 1 vmware",
- "parentJobUid": "5d036027-3680-4057-8fe5-004f1c61484d",
- "backupServerId": 7843,
- "status": "Success",
- "details": [ ],
- "lastRun": "2025-07-13T14:05:04.853Z",
- "lastRunDurationSec": 103,
- "avgDurationSec": 103,
- "lastTransferredDataBytes": 640
}
], - "totalCount": 2
}
Get All SureBackup Jobs
Returns a collection resource representation of all SureBackup jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "sureBackupJobUid": "c6868894-5c75-435c-98e6-1b9ea726bca4",
- "backupServerId": 7199,
- "name": "mssb2",
- "status": "Success",
- "details": [ ],
- "createdBy": "adm-1qa",
- "lastRun": "2023-10-28T07:32:17.86Z",
- "lastRunDurationSec": 301,
- "avgDurationSec": 259
}, - {
- "sureBackupJobUid": "b8c5bde2-3a69-4bde-abeb-244d25c53742",
- "backupServerId": 7200,
- "name": "SureBackup Job 4",
- "status": "Failed",
- "details": [
- "mk-f1 - Publishing"
], - "createdBy": "VBR\\administrator",
- "lastRun": "2023-10-25T12:00:16.537Z",
- "lastRunDurationSec": 95,
- "avgDurationSec": 507
}
], - "totalCount": 2
}
Get SureBackup Job
Returns a resource representation of a SureBackup job with the specified UID.
path Parameters
sureBackupJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "sureBackupJobUid": "c6868894-5c75-435c-98e6-1b9ea726bca4",
- "backupServerId": 7199,
- "name": "mssb2",
- "status": "Success",
- "details": [ ],
- "createdBy": "adm-1qa",
- "lastRun": "2023-10-28T07:32:17.86Z",
- "lastRunDurationSec": 301,
- "avgDurationSec": 259
}
Get All VM Copy Jobs
Returns a collection resource representation of all VM copy jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "vmCopyJobUid": "b33df490-79af-4475-86bf-29e3e94b181e",
- "backupServerId": 11782,
- "status": "Failed",
- "details": [ ],
- "name": "VM Copy Job 1",
- "description": "Created by ALPHA\\administrator at 8/23/2022 22:52.",
- "lastRun": null,
- "lastRunDurationSec": null,
- "avgDurationSec": null,
- "lastTransferredDataBytes": null
}, - {
- "vmCopyJobUid": "45d45fa6-4a19-48ee-b80d-b97e0a2f1225",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "VM Copy Job 2",
- "description": "Created by ALPHA\\adm-1 at 11/7/2023 4:32 PM.",
- "lastRun": "2025-07-17T13:33:19.86Z",
- "lastRunDurationSec": 53,
- "avgDurationSec": 53,
- "lastTransferredDataBytes": 0
}
], - "totalCount": 2
}
Get VM Copy Job
Returns a resource representation of a VM copy job with the specified UID.
path Parameters
vmCopyJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "vmCopyJobUid": "b33df490-79af-4475-86bf-29e3e94b181e",
- "backupServerId": 11782,
- "status": "Failed",
- "details": [ ],
- "name": "VM Copy Job 1",
- "description": "Created by ALPHA\\administrator at 8/23/2022 22:52.",
- "lastRun": null,
- "lastRunDurationSec": null,
- "avgDurationSec": null,
- "lastTransferredDataBytes": null
}
Get All Snapshot-Only Jobs
Returns a collection resource representation of all snapshot-only jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "vmSnapshotOnlyJobUid": "9a0b5006-24cc-4fd9-ab56-347eb353ad60",
- "backupServerId": 11724,
- "status": "Success",
- "details": [ ],
- "name": "Nutanix snapshot job",
- "description": "Created by admin at 10/24/2023 1:36 PM",
- "lastRun": null,
- "lastRunDurationSec": null,
- "avgDurationSec": null
}, - {
- "vmSnapshotOnlyJobUid": "e842ee4a-65b9-41cf-ab77-7d18b4eacad7",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Nutanix Snapshot Job",
- "description": "Created by admin1 (ms-nutanix-proxy) at 10/11/2023 5:41 PM",
- "lastRun": "2025-07-07T00:00:01.01Z",
- "lastRunDurationSec": 205,
- "avgDurationSec": 99
}, - {
- "vmSnapshotOnlyJobUid": "03708850-ea1d-420c-8d8d-7ddfbe9c8bfa",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "AHV Backup Proxy ms-nutanix-proxy Protection",
- "description": "Predefined policy",
- "lastRun": "2025-07-08T22:00:01.013Z",
- "lastRunDurationSec": 91,
- "avgDurationSec": 51
}
], - "totalCount": 3
}
Get Snapshot-Only Job
Returns a resource representation of a snapshot-only job with the specified UID.
path Parameters
vmSnapshotOnlyJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "vmSnapshotOnlyJobUid": "03708850-ea1d-420c-8d8d-7ddfbe9c8bfa",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "AHV Backup Proxy ms-nutanix-proxy Protection",
- "description": "Predefined policy",
- "lastRun": "2025-07-08T22:00:01.013Z",
- "lastRunDurationSec": 91,
- "avgDurationSec": 51
}
Get All CDP Policies
Returns a collection resource representation of all CDP policies.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "cdpPolicyUid": "d6075fa1-2f33-4cf0-b030-2bc9203155cd",
- "backupServerId": 7200,
- "status": "Disabled",
- "name": "CDP Policy 6 vvg",
- "description": "Created by VBR\\Administrator at 10/27/2023 2:35 PM.",
- "rpoSec": 15,
- "shortTermRetentionSec": 14400,
- "longTermRetentionSec": 28800,
- "keepRestorePointsInDays": 7,
- "clusterReference": "",
- "hostReference": "host-148",
- "replicaNameSuffix": "_CDPreplica",
- "sourceProxyAutoDetect": true,
- "targetProxyAutoDetect": true,
- "isApplicationAwareEnabled": false
}, - {
- "cdpPolicyUid": "2626be17-a5e3-468e-9e43-868d616b27cc",
- "backupServerId": 7200,
- "status": "Disabled",
- "name": "CDP Policy 4 vvg",
- "description": "Created by VBR\\administrator at 5/16/2023 2:19 PM.",
- "rpoSec": 15,
- "shortTermRetentionSec": 14400,
- "longTermRetentionSec": 28800,
- "keepRestorePointsInDays": 7,
- "clusterReference": "",
- "hostReference": "host-86687",
- "replicaNameSuffix": "_CDPreplica",
- "sourceProxyAutoDetect": true,
- "targetProxyAutoDetect": true,
- "isApplicationAwareEnabled": false
}, - {
- "cdpPolicyUid": "cca4a1cd-795e-4e08-b4ff-98ffc338f818",
- "backupServerId": 7200,
- "status": "Disabled",
- "name": "CDP Policy 7 vvg",
- "description": "Created by VBR\\Administrator at 10/27/2023 2:38 PM.",
- "rpoSec": 12,
- "shortTermRetentionSec": 10800,
- "longTermRetentionSec": 21600,
- "keepRestorePointsInDays": 6,
- "clusterReference": "",
- "hostReference": "host-148",
- "replicaNameSuffix": "_CDPreplica",
- "sourceProxyAutoDetect": true,
- "targetProxyAutoDetect": true,
- "isApplicationAwareEnabled": true
}
], - "totalCount": 3
}
Get CDP Policy
Returns a resource representation of a CDP policy with the specified UID.
path Parameters
cdpPolicyUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "cdpPolicyUid": "cca4a1cd-795e-4e08-b4ff-98ffc338f818",
- "backupServerId": 7200,
- "status": "Disabled",
- "name": "CDP Policy 7 vvg",
- "description": "Created by VBR\\Administrator at 10/27/2023 2:38 PM.",
- "rpoSec": 12,
- "shortTermRetentionSec": 10800,
- "longTermRetentionSec": 21600,
- "keepRestorePointsInDays": 6,
- "clusterReference": "",
- "hostReference": "host-148",
- "replicaNameSuffix": "_CDPreplica",
- "sourceProxyAutoDetect": true,
- "targetProxyAutoDetect": true,
- "isApplicationAwareEnabled": true
}
Get All File to Tape Jobs
Returns a collection resource representation of all file to tape jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "fileToTapeJobUid": "061ebecc-99a4-47f2-8cf3-46e8d256e420",
- "backupServerId": 11782,
- "status": "Warning",
- "details": [
- "Job finished with warning at 10/18/2023 5:00:46 AM ",
- "Failed to enumerate path ms-22-shares.tech.local:/ on ms-22-shares.tech.local:/NFS-Share"
], - "name": "FTTJ (Lin Srv)",
- "description": "Created by adm-1 at 10/28/2022 6:45 PM.",
- "lastRun": null,
- "lastRunDurationSec": null,
- "avgDurationSec": null,
- "lastTransferredDataBytes": null
}, - {
- "fileToTapeJobUid": "7cb8322d-ab72-45c4-b91a-6dfe18044f9c",
- "backupServerId": 11724,
- "status": "Success",
- "details": [ ],
- "VbrJobs_Get": null,
- "name": "File to Tape Job 1",
- "description": "Created by administrator at 10/26/2022 12:53 AM.",
- "lastRun": "2025-07-01T16:47:51.893Z",
- "lastRunDurationSec": 40,
- "avgDurationSec": 27,
- "lastTransferredDataBytes": 298
}, - {
- "fileToTapeJobUid": "38e7095f-c3fe-459c-81d1-6ee2461ff03f",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "FTTJ (Win Srv)",
- "description": "Created by adm-1 at 11/12/2022 12:21 AM.",
- "lastRun": "2025-07-10T22:00:34.567Z",
- "lastRunDurationSec": 44,
- "avgDurationSec": 34,
- "lastTransferredDataBytes": 264151040
}
], - "totalCount": 3
}
Get File to Tape Job
Returns a resource representation of a file to tape job with the specified UID.
path Parameters
fileToTapeJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "fileToTapeJobUid": "38e7095f-c3fe-459c-81d1-6ee2461ff03f",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "FTTJ (Win Srv)",
- "description": "Created by adm-1 at 11/12/2022 12:21 AM.",
- "lastRun": "2025-07-10T22:00:34.567Z",
- "lastRunDurationSec": 44,
- "avgDurationSec": 34,
- "lastTransferredDataBytes": 264151040
}
Get All Object to Tape Jobs
Returns a collection resource representation of all object to tape jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "objectToTapeJobUid": "978f8aed-1962-4039-a34f-3e32f7204969",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Object to Tape Job 1",
- "description": "Created by VBR\\administrator at 10/4/2023 11:14 PM.",
- "lastRun": "2023-10-11T07:42:04.923Z",
- "lastRunDurationSec": 19,
- "avgDurationSec": 47,
- "lastTransferredDataBytes": 0
}, - {
- "objectToTapeJobUid": "19018cac-8d5e-4942-a416-5e8506f7712b",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Object to Tape Job 2",
- "description": "Created by VBR\\administrator at 10/5/2023 12:23 AM.",
- "lastRun": "2023-10-05T07:24:01.563Z",
- "lastRunDurationSec": 35,
- "avgDurationSec": 35,
- "lastTransferredDataBytes": 12395065
}, - {
- "objectToTapeJobUid": "fb30c274-bf2b-4b00-985b-65052a394696",
- "backupServerId": 7430,
- "status": "Warning",
- "details": [
- "Failed to enumerate path [<ObjectStorageHostPath><Container>isobucket</Container><Delimiter>/</Delimiter><IsObject>False</IsObject><InstanceId>https://172.36.49.6_us-east-1_02d6176db185dc93cb1b899f7c6078f08654445fe8cd2b6ce98d8855f66bcff4</InstanceId></ObjectStorageHostPath>] on host S3 Compatible (Minio)",
- "Job finished with warning at 10/24/2023 18:00:17"
], - "name": "OTT Job - S3 Compatible - Bucket",
- "description": "Created by VBR\\administrator at 29/08/2023 18:08.",
- "lastRun": "2023-10-24T16:00:09.577Z",
- "lastRunDurationSec": 7,
- "avgDurationSec": 31,
- "lastTransferredDataBytes": 0
}
], - "totalCount": 3
}
Get Object to Tape Job
Returns a resource representation of an object to tape job with the specified UID.
path Parameters
objectToTapeJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "objectToTapeJobUid": "19018cac-8d5e-4942-a416-5e8506f7712b",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Object to Tape Job 2",
- "description": "Created by VBR\\administrator at 10/5/2023 12:23 AM.",
- "lastRun": "2023-10-05T07:24:01.563Z",
- "lastRunDurationSec": 35,
- "avgDurationSec": 35,
- "lastTransferredDataBytes": 12395065
}
Get All File Copy Jobs
Returns a collection resource representation of all file copy jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "fileCopyJobUid": "7cb8322d-ab72-45c4-b91a-6dfe18044f9c",
- "backupServerId": 11724,
- "status": "Success",
- "details": [ ],
- "name": "File Copy Job 1",
- "description": "Created by administrator at 10/26/2023 12:53 AM.",
- "lastRun": "2025-07-10T16:47:51.893Z",
- "lastRunDurationSec": 40,
- "avgDurationSec": 27,
- "lastTransferredDataBytes": 346745439
}, - {
- "fileCopyJobUid": "38e7095f-c3fe-459c-81d1-6ee2461ff03f",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "FCJ (Win Srv)",
- "description": "Created by adm-1 at 10/12/2023 12:21 AM.",
- "lastRun": "2025-07-10T22:00:34.567Z",
- "lastRunDurationSec": 44,
- "avgDurationSec": 34,
- "lastTransferredDataBytes": 264151040
}
], - "totalCount": 2
}
Get File Copy Job
Returns a resource representation of a file copy job with the specified UID.
path Parameters
fileCopyJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "fileCopyJobUid": "38e7095f-c3fe-459c-81d1-6ee2461ff03f",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "FCJ (Win Srv)",
- "description": "Created by adm-1 at 10/12/2021 12:21 AM.",
- "lastRun": "2025-07-10T22:00:34.567Z",
- "lastRunDurationSec": 44,
- "avgDurationSec": 34,
- "lastTransferredDataBytes": 264151040
}
Get All File Backup Jobs
Returns a collection resource representation of all file backup jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "fileBackupJobUid": "54196919-a461-4db1-9460-221d668f3846",
- "backupServerId": 11724,
- "status": "Success",
- "details": [ ],
- "name": "File Backup Job ii-1st vbr",
- "description": "Created by MMF-WIN19VBR\\Administrator at 12/15/2022 12:08 PM.",
- "lastRun": "2025-07-15T20:08:59.89Z",
- "lastRunDurationSec": 83,
- "avgDurationSec": 83,
- "lastTransferredDataBytes": 1298
}, - {
- "fileBackupJobUid": "42e93953-5fb1-4699-b076-269d86c4f48c",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "FBJ (NFS)_1",
- "description": "Created by adm-1 at 10/28/2023 6:33 PM.",
- "lastRun": "2023-10-29T14:15:15.86Z",
- "lastRunDurationSec": 49,
- "avgDurationSec": 55,
- "lastTransferredDataBytes": 0
}, - {
- "fileBackupJobUid": "24b208c4-853d-4155-8fa8-619bb9c06264",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Windows Server Backup Job",
- "description": "Created by adm-1 at 11/9/2023 1:02 PM.",
- "lastRun": "2025-07-12T21:01:03.507Z",
- "lastRunDurationSec": 694,
- "avgDurationSec": 897,
- "lastTransferredDataBytes": 1998912506
}
], - "totalCount": 3
}
Get File Backup Job
Returns a resource representation of a file backup job with the specified UID.
path Parameters
fileBackupJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "fileBackupJobUid": "24b208c4-853d-4155-8fa8-619bb9c06264",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Windows Server Backup Job",
- "description": "Created by adm-1 at 11/9/2023 1:02 PM.",
- "lastRun": "2025-07-12T21:01:03.507Z",
- "lastRunDurationSec": 694,
- "avgDurationSec": 897,
- "lastTransferredDataBytes": 1998912506
}
Get All Agent Backup Jobs
Returns a collection resource representation of all agent backup jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "agentBackupJobUid": "1c8d3641-5c3c-48ac-987b-06b676b70f3c",
- "backupServerId": 11782,
- "status": "Warning",
- "details": [
- "Job finished with warning at 10/23/2023 10:00:20 PM ",
- "Nothing to process",
- "Skipping ms-22.tech.local: server is already assigned to backup policy Windows Agent Backup Policy"
], - "name": "Windows Agent Backup Job",
- "description": "Managed by server (Volume Level backup)\nBackup - Entire Computer\nRetention - 7days \nSynthetic Full - Sat\nGFS - 2w,1m,1y",
- "platform": "MicrosoftWindows",
- "lastRun": "2023-10-23T19:00:08.703Z",
- "lastRunDurationSec": 18,
- "avgDurationSec": 24,
- "lastTransferredDataBytes": 0
}, - {
- "agentBackupJobUid": "12eaadc2-3ec4-4279-9874-0c33750506b8",
- "backupServerId": 11782,
- "status": "Failed",
- "details": [
- "Job finished with error at 10/25/2023 9:36:02 AM",
- "Processing ms-ub-02"
], - "name": "Windows Agent Backup Job 1",
- "description": "Managed by server (Entire computer)\nRetention - 7days",
- "platform": "MicrosoftWindows",
- "lastRun": "2023-10-25T06:35:10.72Z",
- "lastRunDurationSec": 35,
- "avgDurationSec": 35,
- "lastTransferredDataBytes": 0
}, - {
- "agentBackupJobUid": "23176e32-6ee8-4cef-bf93-1ed1a2544c28",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Linux Agent Backup Job",
- "description": "Managed by server (Entire computer)\nRetention - 7days",
- "platform": "Linux",
- "lastRun": "2025-07-13T06:00:09.133Z",
- "lastRunDurationSec": 213,
- "avgDurationSec": 252,
- "lastTransferredDataBytes": 91134397
}
], - "totalCount": 3
}
Get Agent Backup Job
Returns a resource representation of an agent backup job with the specified UID.
path Parameters
agentBackupJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "agentBackupJobUid": "23176e32-6ee8-4cef-bf93-1ed1a2544c28",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Linux Agent Backup Job",
- "description": "Managed by server (Entire computer)\nRetention - 7days",
- "platform": "Linux",
- "lastRun": "2025-07-13T06:00:09.133Z",
- "lastRunDurationSec": 213,
- "avgDurationSec": 252,
- "lastTransferredDataBytes": 91134397
}
Get All Veeam Backup Agent Policies
Returns a collection resource representation of all backup policies assigned to Veeam backup agents.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "agentPolicyUid": "599b1cd4-0657-4b52-b7f3-27bd45fe2057",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Windows Agent Backup Policy",
- "description": "Created by adm-1 at 11/10/2021 12:36 PM.",
- "platform": "MicrosoftWindows",
- "childJobUids": [
- "88cad705-5bda-4043-82ae-f826cb96cb79"
]
}, - {
- "agentPolicyUid": "9ab6158a-ff7e-46f1-ab34-5792a5a2a4dc",
- "backupServerId": 11782,
- "status": "None",
- "details": [ ],
- "name": "Oracle Solaris i386 Backup Policy",
- "description": "Created by adm-1 at 11/10/2021 3:05 PM.",
- "platform": "IbmAixOracleSolaris",
- "childJobUids": [ ]
}, - {
- "agentPolicyUid": "727a46ac-8ea0-43b7-b869-6d2419fcaecf",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Linux Agent Backup Policy",
- "description": "Managed by agent (File level)",
- "platform": "Linux",
- "childJobUids": [
- "898cd2ed-7d8d-4a54-b9f1-b5f42bf883ce"
]
}
], - "totalCount": 3
}
Get Veeam Backup Agent Policy
Returns a resource representation of a Veeam backup agent policy with the specified UID.
path Parameters
agentPolicyUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "agentPolicyUid": "727a46ac-8ea0-43b7-b869-6d2419fcaecf",
- "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "name": "Linux Agent Backup Policy",
- "description": "Managed by agent (File level)",
- "platform": "Linux",
- "childJobUids": [
- "898cd2ed-7d8d-4a54-b9f1-b5f42bf883ce"
]
}
Get All Veeam Backup Agent Policy Child Jobs
Returns a collection resource representation of all child jobs of a Veeam backup agent policy with the specified UID.
path Parameters
agentPolicyUid required | string <uuid> |
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "childJobUid": "88cad705-5bda-4043-82ae-f826cb96cb79",
- "name": "Windows Agent Backup Policy - ms-22-agent",
- "agentPolicyUid": "599b1cd4-0657-4b52-b7f3-27bd45fe2057",
- "computerName": "ms-22-agent",
- "protectedAgentUid": "ba746a5f-0a6b-418a-bbb9-e9c347bfdcc4",
- "ipAddresses": [
- "172.24.153.95"
], - "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "lastRun": "2025-07-13T03:00:12.7Z",
- "lastRunDurationSec": 349,
- "avgDurationSec": 577,
- "lastTransferredDataBytes": 916775455
}, - {
- "childJobUid": "898cd2ed-7d8d-4a54-b9f1-b5f42bf883ce",
- "name": "Linux Agent Backup Policy - ms-ub-01",
- "agentPolicyUid": "599b1cd4-0657-4b52-b7f3-27bd45fe2057",
- "computerName": "ms-ub-01",
- "protectedAgentUid": "6f3519ba-33c3-47dd-93a3-3a08925b157a",
- "ipAddresses": [
- "172.25.48.69"
], - "backupServerId": 11782,
- "status": "Success",
- "details": [ ],
- "lastRun": "2025-07-13T07:00:03.123Z",
- "lastRunDurationSec": 70,
- "avgDurationSec": 87,
- "lastTransferredDataBytes": 154243
}
], - "totalCount": 2
}
Get All Application Backup Jobs
Returns a collection resource representation of all backup jobs protecting applications.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "applicationBackupJobUid": "1fabfc4e-3b5b-40b7-8a19-866c35a89cdd",
- "backupServerId": 7475,
- "status": "Running",
- "details": [ ],
- "name": "SAP on Oracle util_file Policy",
- "description": "Created by administrator at 04/10/2023 17:20.",
- "platform": "SapOnOracle",
- "lastRun": "2023-10-16T15:06:43.607Z",
- "lastTransferredDataBytes": 0
}, - {
- "applicationBackupJobUid": "56a021f9-5fd6-438f-bfcc-45ffc4c98fbe",
- "backupServerId": 7475,
- "status": "Failed",
- "details": [
- "Failed to prepare plug-in RMAN Windows pgWinOracleD.n.local: Failed to connect to Veeam Data Mover Service on host 'pgWinOracleD.n.local', port '6162'",
- "Processing finished with errors at 25/10/2023 13:57:15"
], - "name": "Oracle RMAN Policy",
- "description": "Created by administrator at 04/10/2023 15:28.",
- "platform": "Oracle",
- "lastRun": "2023-10-25T11:54:27.257Z",
- "lastTransferredDataBytes": 0
}, - {
- "applicationBackupJobUid": "1e693c96-415a-4846-a797-1e16465a28dd",
- "backupServerId": 7199,
- "status": "None",
- "details": [ ],
- "name": "Oracle RMAN Policy",
- "description": "Created by administrator at 2/7/2023 5:25 PM.",
- "platform": "Oracle",
- "lastRun": "2023-10-13T20:12:15.683Z",
- "lastTransferredDataBytes": 0
}
], - "totalCount": 3
}
Get Application Backup Job
Returns a resource representation of an application backup job with the specified UID.
path Parameters
applicationBackupJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "applicationBackupJobUid": "1fabfc4e-3b5b-40b7-8a19-866c35a89cdd",
- "backupServerId": 7475,
- "status": "Running",
- "details": [ ],
- "name": "SAP on Oracle util_file Policy",
- "description": "Created by administrator at 04/10/2023 17:20.",
- "platform": "SapOnOracle",
- "lastRun": "2023-10-16T15:06:43.607Z",
- "lastTransferredDataBytes": 0
}
Get All Enterprise Application Transaction Log Backup Jobs
Returns a collection resource representation of all backup jobs protecting Enterprise Application transaction logs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "applicationTransactionLogBackupJobUid": "eb9bfce9-0a59-464c-b735-7296186242d8",
- "parentApplicationJobUid": "e61ee069-c946-4c13-8e16-95ca967ddc2b",
- "backupServerId": 11702,
- "status": "Running",
- "details": [ ],
- "name": "ORMAN Policy C Redo Logs Backup",
- "description": "Created by administrator at 19/10/2023 18:28.",
- "platform": "Oracle",
- "lastRun": "2025-07-06T17:45:36.84Z",
- "lastTransferredDataBytes": null
}, - {
- "applicationTransactionLogBackupJobUid": "b4f961d1-df11-4466-a26a-a5fc64b9c4ed",
- "parentApplicationJobUid": "cb67db7d-1b97-4273-ac43-0ba84487287b",
- "backupServerId": 11702,
- "status": "Running",
- "details": [ ],
- "name": "SAPHANA Policy K Log Backup",
- "description": "Created by administrator at 19/10/2023 19:19.",
- "platform": "SapHana",
- "lastRun": "2025-07-07T11:00:23.887Z",
- "lastTransferredDataBytes": null
}, - {
- "applicationTransactionLogBackupJobUid": "21a08882-e599-4d04-bae8-ae54415378d8",
- "parentApplicationJobUid": "6bd5c287-33d1-48bc-8fdd-2f2df50bbc7a",
- "backupServerId": 11702,
- "status": "Running",
- "details": [ ],
- "name": "ORMAN Policy D Redo Logs Backup",
- "description": "Created by administrator at 19/10/2023 18:24.",
- "platform": "Oracle",
- "lastRun": "2025-07-07T11:01:54.15Z",
- "lastTransferredDataBytes": 1933668
}
], - "totalCount": 3
}
Get Enterprise Application Transaction Log Backup Job
Returns a resource representation of a transaction log backup job initiated by an Enterprise Application backup job with the specified UID.
path Parameters
applicationJobUid required | string <uuid> |
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "applicationTransactionLogBackupJobUid": "21a08882-e599-4d04-bae8-ae54415378d8",
- "parentApplicationJobUid": "6bd5c287-33d1-48bc-8fdd-2f2df50bbc7a",
- "backupServerId": 11702,
- "status": "Running",
- "details": [ ],
- "name": "ORMAN Policy D Redo Logs Backup",
- "description": "Created by administrator at 19/10/2023 18:24.",
- "platform": "Oracle",
- "lastRun": "2025-07-07T11:01:54.15Z",
- "lastTransferredDataBytes": 1933668
}
Get All Transaction Log Backup Jobs
Returns a collection resource representation of all transaction log backup jobs.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "transactionJobUid": "8a8a5870-f7dd-452a-8aba-98e32f3b0a11",
- "name": "Lin Oracle Backup Job Oracle Redo Log Backup",
- "type": "OracleSqlLogBackup",
- "status": "Success",
- "details": [ ],
- "backupServerId": 11782,
- "backupServerName": "ms-win22-vbr",
- "lastRun": null,
- "lastTransferredDataBytes": null,
- "parentJob": {
- "parentJobUid": "544b2d17-77bb-4763-bb24-25946467f03e",
- "parentJobName": "Lin Oracle Backup Job",
- "parentJobType": "VmBackup"
}
}, - {
- "transactionJobUid": "203b554b-6756-47a0-8441-b097ca5d087d",
- "name": "SQL VM Backup SQL Server Transaction Log Backup",
- "type": "MicrosoftSqlLogBackup",
- "status": "Running",
- "details": [ ],
- "backupServerId": 11782,
- "backupServerName": "ms-win22-vbr",
- "lastRun": "2023-03-13T19:02:37.64Z",
- "lastTransferredDataBytes": 9291,
- "parentJob": {
- "parentJobUid": "cd1e7c2d-4d43-4201-b995-5ccb39c5980d",
- "parentJobName": "SQL VM Backup",
- "parentJobType": "VmBackup"
}
}, - {
- "transactionJobUid": "2dd343fe-9948-400e-a79d-ed938e39ebb1",
- "name": "ii log SQL Server Transaction Log Backup",
- "type": "MicrosoftSqlLogBackup",
- "status": "Success",
- "details": [ ],
- "backupServerId": 11782,
- "backupServerName": "ms-win22-vbr",
- "lastRun": null,
- "lastTransferredDataBytes": null,
- "parentJob": {
- "parentJobUid": "999d0cc4-c930-430a-a4bd-bad48f176695",
- "parentJobName": "ii log",
- "parentJobType": "VmBackup"
}
}
], - "totalCount": 3
}
Get Transaction Log Backup Job
Returns a resource respresentation of a transaction log backup job with the specified UID.
path Parameters
transactionJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "transactionJobUid": "2dd343fe-9948-400e-a79d-ed938e39ebb1",
- "name": "ii log SQL Server Transaction Log Backup",
- "type": "MicrosoftSqlLogBackup",
- "status": "Success",
- "details": [ ],
- "backupServerId": 11782,
- "backupServerName": "ms-win22-vbr",
- "lastRun": null,
- "lastTransferredDataBytes": null,
- "parentJob": {
- "parentJobUid": "999d0cc4-c930-430a-a4bd-bad48f176695",
- "parentJobName": "ii log",
- "parentJobType": "VmBackup"
}
}
Get All Object Storage Jobs
Returns a collection resource representation of all jobs that store backup files in object storage repositories.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Forbidden
- curl
- 200
- 403
{- "items": [
- {
- "objectStoraBackupJobUid": "a9c4e534-bf09-4dc3-86ed-90de8a031d4a",
- "backupServerId": 7430,
- "status": "Failed",
- "details": [
- "Cannot find an export for object: <ObjectStorageHostPath><Delimiter>/</Delimiter><IsObject>False</IsObject><InstanceId>mmf2_AzureCloud</InstanceId></ObjectStorageHostPath>",
- "Job finished with error at 24/10/2023 22:32:07"
], - "name": "OSB Job - Azure Account",
- "description": "Created by administrator at 10/09/2023 13:39.",
- "lastRun": "2023-10-24T20:31:54.117Z",
- "lastRunDurationSec": 13,
- "avgDurationSec": 39,
- "lastTransferredDataBytes": 0
}, - {
- "objectStoraBackupJobUid": "41ffdfce-431a-4da7-9722-a14ad721c5a2",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Object Storage Backup Job 1",
- "description": "Created by administrator at 10/4/2023 11:44 PM.",
- "lastRun": "2025-07-11T07:42:01.5Z",
- "lastRunDurationSec": 68,
- "avgDurationSec": 84,
- "lastTransferredDataBytes": 0
}, - {
- "objectStoraBackupJobUid": "ea9b5e93-b791-4b83-bca6-a66019e04c1f",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Object Storage Backup Job 2",
- "description": "Created by administrator at 10/4/2023 11:49 PM.",
- "lastRun": "2025-07-05T06:49:53.81Z",
- "lastRunDurationSec": 50,
- "avgDurationSec": 50,
- "lastTransferredDataBytes": 0
}
], - "totalCount": 3
}
Get Object Storage Job
Returns a resource representation of an object storage job with the specified UID.
path Parameters
objectStorageJobUid required | string <uuid> |
Success
Forbidden
- curl
- 200
- 403
{- "objectStoraBackupJobUid": "ea9b5e93-b791-4b83-bca6-a66019e04c1f",
- "backupServerId": 5,
- "status": "Success",
- "details": [ ],
- "name": "Object Storage Backup Job 2",
- "description": "Created by administrator at 10/4/2023 11:49 PM.",
- "lastRun": "2025-07-05T06:49:53.81Z",
- "lastRunDurationSec": 50,
- "avgDurationSec": 50,
- "lastTransferredDataBytes": 0
}