Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
RESTful API Reference

/Jobs/{ID}

Represents a backup job with a specified ID.

Resource URL

The URL of the reference resource representation:

https://<Backup-Office365>:4443/v2/Jobs/{ID}

Related Resources

Methods

The following methods are supported for the /Jobs/{ID} resource:

Properties

The /Jobs/{ID} resource has the following properties:

Property

Type

Description

Id

string

Specifies the ID of the backup job.

For example, "Id": "93089cfa-81d6-4551-8a7b-a7290868d6f9".

Name

string

Specifies the name of the backup job.

For example, "name": "Backup Job ABC".

Description

string

Specifies the description of the backup job.

For example, "description": "Critical Mailboxes".

LastStatus

string

Specifies the latest status of the backup job:

  • Stopped
  • Running
  • Success
  • Warning
  • Failed

For example, "lastStatus": "Success".

LastRun

UTC

Specifies the time of the last run of a backup job.

For example, "lastRun": "2017-03-01T09:35:59.0469161Z".

NextRun

UTC

Specifies the time of the next run of a backup job per the backup job schedule.

For example, "nextRun": "2017-03-04T22:00:00Z".

IsEnabled

bool

If set to True, specifies that the backup job is enabled.

For example, "isEnabled": "true".

BackupType

backupType

Specifies the type of the backup job:

  • entireOrganization
  • selectedItems

SchedulePolicy

SchedulePolicy

Specifies the backup job scheduling options.

RunNow

bool

If set to True, the job will run right after it is created.

For example, "IsRun": "true".

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

SchedulePolicy

The backup job schedule has the following properties:

Property

Type

Description

Type

string

Specifies the job schedule type:

  • Daily: runs the backup job on specific days.
  • Periodically: runs the backup job repeatedly throughout a day with a specific time interval.

For example, "type": "daily".

DailyType

string

Specifies the days when the backup job will run:

  • Everyday
  • Weekends
  • Workdays
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday

For example, "dailyType": "Sunday".

DailyTime

UTC

Specifies the time when the job will start.

For example, "dailyTime": "08:00:00".

Periodically

Every

string

Specifies the time interval between the job runs:

  • Minutes5
  • Minutes10
  • Minutes15
  • Minutes30
  • Hours1
  • Hours2
  • Hours4
  • Hours8

For example, "periodicallyEvery": "Hours1".

BackupWindowEnabled

bool

If set to True, indicates that a backup window feature is enabled for this job.

For example, "backupWindowEnabled": "true".

BackupWindow

BackupWindowSettings

Specifies the job's backup window settings. A backup window is a time period within which the job must be completed.

RetryEnabled

bool

If set to True, indicates that Veeam Backup for Microsoft Office 365 will attempt to restart a backup job if it fails for some reason.

For example, "retryEnabled": "true".

RetryNumber

int

Specifies the number of attempts to run the backup job.

For example, "retryNumber": 5.

RetryWait
Interval

int

Specifies the time intervals between the job retry attempts (minutes).

For example, "retryWaitInterval": 15.

BackupWindowSettings

The job's backup window has the following properties:

Property

Type

Description

BackupWindow

bool

Specifies an hourly scheme for the backup window. The scheduling scheme consists of 168 boolean elements. These elements can be logically divided into 7 groups by 24. Each group represents a day of the week starting from Sunday. Each element represents a backup hour:

  • True - the allowed backup hour
  • False - the prohibited backup hour

For example, to allow a backup job to run only on Sundays, set the first 24 elements to True.

MinuteOffset

int

Specifies the current minute offset from the UTC time.

For example, "minuteOffset": 15.

Resource Representation

The /Jobs/{ID} resource has the following representation:

{

 "id": "3c407448-4d05-432f-a651-144827bed5ce",

 "name": "test_job",

 "description": "",

 "lastRun": "2017-05-30T12:19:14.7927466Z",

 "nextRun": "2017-06-02T02:00:00Z",

 "isEnabled": true,

 "backupType": "SelectedItems",

 "lastStatus": "Success",

 "schedulePolicy": {

   "backupWindowEnabled": true,

   "backupWindowSettings": {

     "backupWindow": [

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       false,

       false,

       false,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       false,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       false,

       false,

       false,

       true,

       true,

       true,

       true,

       true,

       false,

       false,

       false,

       false,

       false,

       false,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       false,

       false,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       false,

       false,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       false,

       false,

       false,

       false,

       false,

       false,

       false,

       false,

       false,

       false,

       false,

       false,

       false,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true,

       true

     ],

     "minuteOffset": 0

   },

   "type": "Daily",

   "dailyType": "Friday",

   "dailyTime": "19:00:00",

   "retryEnabled": false

 },

 "_links": {

   "self": {

     "href": "https://support.east.local:4443/v2/jobs/3c407448-4d05-432f-a651-144827bed5ce"

   },

   "organization": {

     "href": "https://support.east.local:4443/v2/organizations/63e92db4-8c0a-46df-ba92-15f46011c4a5"

   },

   "backupRepository": {

     "href": "https://support.east.local:4443/v2/backuprepositories/ce19de31-329d-4f0f-b85e-4424cc2e6821"

   },

   "jobsessions": {

     "href": "https://support.east.local:4443/v2/jobs/3c407448-4d05-432f-a651-144827bed5ce/jobsessions"

   },

   "excludedItems": {

     "href": "https://support.east.local:4443/v2/jobs/3c407448-4d05-432f-a651-144827bed5ce/excludedItems"

   },

   "selectedItems": {

     "href": "https://support.east.local:4443/v2/jobs/3c407448-4d05-432f-a651-144827bed5ce/selectedItems"

   }

 }

}

 

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference