Veeam ONE 13
REST API Reference
Related documents

Veeam Backup & Replication Jobs

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.

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/vbrJobs/vmBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get VM Backup Job
Returns a resource representation of a VM backup job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/vmBackupJobs/{vmBackupJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/cloudDirectorBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get VMware Cloud Director Backup Job
Returns a resource representation of a VMware Cloud Director job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/cloudDirectorBackupJobs/{cloudDirectorBackupJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/vmReplicationJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get VM Replication Job
Returns a resource representation of a VM replication job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/vmReplicationJobs/{vmReplicationJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/cloudDirectorReplicationJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get VMware Cloud Director Replication Job
Returns a collection resource representation of all replication jobs protecting VMware Cloud Director objects.


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


403
Forbidden


get/api/v2.3/vbrJobs/cloudDirectorReplicationJobs/{cloudDirectorReplicationJobUid}
Request samples 
Response samples 
application/json
{
  • "cloudDirectorReplicationJobUid": "be65e529-d69f-453a-93f9-ce529eb87daa",
  • "backupServerId": 11724,
  • "status": "Warning",
  • "details": [
    ],
  • "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.


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/vbrJobs/backupToTapeJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Backup to Tape Job
Returns a resource representation of a backup to tape job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/backupToTapeJobs/{backupToTapeJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/backupCopyJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get Backup Copy Job
Returns a resource representation of a backup copy job.


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


403
Forbidden


get/api/v2.3/vbrJobs/backupCopyJobs/{backupCopyJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


SecurityBearer 
Request 
path Parameters
backupCopyJobUid
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/vbrJobs/backupCopyJobs/{backupCopyJobUid}/childJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All SureBackup Jobs
Returns a collection resource representation of all SureBackup jobs.


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/vbrJobs/sureBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get SureBackup Job
Returns a resource representation of a SureBackup job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/sureBackupJobs/{sureBackupJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/vmCopyJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get VM Copy Job
Returns a resource representation of a VM copy job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/vmCopyJobs/{vmCopyJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/vmSnapshotOnlyJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Snapshot-Only Job
Returns a resource representation of a snapshot-only job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/vmSnapshotOnlyJobs/{vmSnapshotOnlyJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/cdpPolicies
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get CDP Policy
Returns a resource representation of a CDP policy with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/cdpPolicies/{cdpPolicyUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/fileToTapeJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get File to Tape Job
Returns a resource representation of a file to tape job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/fileToTapeJobs/{fileToTapeJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/objectToTapeJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Object to Tape Job
Returns a resource representation of an object to tape job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/objectToTapeJobs/{objectToTapeJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/fileCopyJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get File Copy Job
Returns a resource representation of a file copy job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/fileCopyJobs/{fileCopyJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/fileBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get File Backup Job
Returns a resource representation of a file backup job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/fileBackupJobs/{fileBackupJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/agentBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Agent Backup Job
Returns a resource representation of an agent backup job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/agentBackupJobs/{agentBackupJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/agentPolicies
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Veeam Backup Agent Policy
Returns a resource representation of a Veeam backup agent policy with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/agentPolicies/{agentPolicyUid}
Request samples 
Response samples 
application/json
{
  • "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": [
    ]
}
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.


SecurityBearer 
Request 
path Parameters
agentPolicyUid
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/vbrJobs/agentPolicies/{agentPolicyUid}/childJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 2
}
Get All Application Backup Jobs
Returns a collection resource representation of all backup jobs protecting 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/vbrJobs/applicationBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Application Backup Job
Returns a resource representation of an application backup job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/applicationBackupJobs/{applicationBackupJobUid}
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/applicationBackupJobs/logJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "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.


SecurityBearer 
Request 
path Parameters
applicationJobUid
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/vbrJobs/applicationBackupJobs/{applicationJobUid}/logJobs
Request samples 
Response samples 
application/json
{
  • "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.


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/vbrJobs/transactionLogBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Transaction Log Backup Job
Returns a resource respresentation of a transaction log backup job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/transactionLogBackupJobs/{transactionJobUid}
Request samples 
Response samples 
application/json
{
  • "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": {
    }
}
Get All Object Storage Jobs
Returns a collection resource representation of all jobs that store backup files in object storage repositories.


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/vbrJobs/objectStorageBackupJobs
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "totalCount": 3
}
Get Object Storage Job
Returns a resource representation of an object storage job with the specified UID.


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


403
Forbidden


get/api/v2.3/vbrJobs/objectStorageBackupJobs/{objectStorageJobUid}
Request samples 
Response samples 
application/json
{
  • "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
}

    
    

                                

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