Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Backup Agent Jobs

The /backupAgents/{id}/jobs resource collection represents a collection of all backup agent jobs managed in Veeam Availability Console. The collection includes resources which represent individual jobs and have system IDs.

Collection URL

https://<Availability-Console>:1281/v2/{id}/backupAgents/{id}/jobs

Collection Representation Backup Agent Jobs

[

 {

   "id": "4610eb17-b41c-4cc5-81d1-938ee6d89b7a",

   "lastSessionStatusId": "None",

   "name": "Workstation: File level backup. Personal files. Local drive. Daily schedule.",

   "description": "",

   "operationModeId": "Workstation",

   "destination": "C:\\VeeamBackup\\",

   "restorePoints": 0,

   "lastRestorePoint": null,

   "backupSize": 0,

   "scheduleType": "Daily",

   "lastRun": "0001-01-01T00:00:00",

   "lastModified": "2018-10-12T01:37:05.2423906+03:00",

   "lastModificationDoneBy": "srv5\\administrator",

   "freeSpace": 0,

   "avgDuration": 0,

   "lastDuration": 0,

   "backupMode": "Folder",

   "targetType": "Local",

   "disabled": false,

   "failureMessage": null,

   "backupPolicyNote": null,

   "cloudConnectAgentUid": "3745c96c-8b7b-40e6-8be5-6de1af6b075b"

   "backupPolicyId": 0,

   "backupPolicyName": null,

   "backupPolicyStatus": "Custom",

   "nextRun": "2018-12-06T00:30:00+03:00",

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/4610eb17-b41c-4cc5-81d1-938ee6d89b7a"

     },

     {

       "rel": "startJob",

       "method": "POST",

       "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/4610eb17-b41c-4cc5-81d1-938ee6d89b7a/start"

     },

     {

       "rel": "delete",

       "method": "DELETE",

       "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/4610eb17-b41c-4cc5-81d1-938ee6d89b7a/delete"

     }

   ]

 },

 {

   "id": "ef7a3d93-c86b-48b6-bb94-7334477dbdf6",

   "lastSessionStatusId": "Success",

   "name": "Workstation: File level backup. Personal files. Local drive. Daily schedule.",

   "description": "Created by srv5\\Administrator at 10/7/2018 5:30 PM.",

   "operationModeId": "Server",

   "destination": "C:\\backup\\",

   "restorePoints": 4,

   "lastRestorePoint": "2018-10-12T08:38:33Z",

   "backupSize": 131362816,

   "scheduleType": "Daily",

   "lastRun": "2018-10-12T08:38:24.727Z",

   "lastModified": "0001-01-01T00:00:00",

   "lastModificationDoneBy": "-",

   "freeSpace": 90625490944,

   "avgDuration": 97,

   "lastDuration": 85,

   "backupModeId": "Folder",

   "targetType": "Local",

   "disabled": false,

   "failureMessage": "",

   "backupPolicyNote": null,

   "cloudConnectAgentUid": "3745c96c-8b7b-40e6-8be5-6de1af6b075b"

   "backupPolicyId": 0,

   "backupPolicyName": null,

   "backupPolicyStatus": "Custom",

   "nextRun": "2018-12-06T00:30:00+03:00",

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/ef7a3d93-c86b-48b6-bb94-7334477dbdf6"

     },

     {

       "rel": "startJob",

       "method": "POST",

       "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/ef7a3d93-c86b-48b6-bb94-7334477dbdf6/start"

     },

     {

       "rel": "delete",

       "method": "DELETE",

       "href": "https://vac:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/ef7a3d93-c86b-48b6-bb94-7334477dbdf6/delete"

     }

   ]

 }

]

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference