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

/Jobs/{ID}

Represents a backup job with the specified ID.

Resource URL

The URL of the reference resource representation:

https://<Backup-Office365>:<Port>/v1/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".

AllMailboxes

bool

If set to True, indicates that the backup job backs up all mailboxes of the associated organization.

For example, "allMailboxes": "true".

ExcludedMailboxes

ExcludedMailboxes

Specifies the array of mailboxes that are excluded from the backup scope.

SelectedMailboxes

SelectedMailboxes

Specifies the array of mailboxes that are added to the backup scope.

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".

SchedulePolicy

SchedulePolicy

Specifies the backup job scheduling options.

IsRun

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).

ExcludedMailboxes

Specifies the array of mailboxes that are excluded from the backup scope. Mailboxes have the following properties:

Property

Type

Description

Id

string

Specifies the ID of the organization mailbox.

For example, "Id": "164db76c-8e1b-49f2-91e1-d978510dec0d"

Email

string

Specifies the e-mail address of the mailbox.

For example, "email": "petep@eastsupport.onmicrosoft.com"

Name

string

Specifies the name of the mailbox.

For example, "name": "Peter Parker"

SelectedMailboxes

Specifies the array of mailboxes that are added to the backup scope. Mailboxes have the following properties:

Property

Type

Description

Id

string

Specifies the ID of the organization mailbox.

For example, "Id": "164db76c-8e1b-49f2-91e1-d978510dec0d"

Email

string

Specifies the e-mail address of the mailbox.

For example, "email": "petep@eastsupport.onmicrosoft.com"

Name

string

Specifies the name of the mailbox.

For example, "name": "Peter Parker"

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".

BackupWindow

BackupWindow

Specifies the job's backup window. 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.

BackupWindow

The job's backup window has the following properties:

Property

Type

Description

BackupIntervalsArray

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": "93089cfa-81d6-4551-8a7b-a7290868d6f9",

   "name": "Backup Job ABC",

   "description": "Critical Mailboxes",

   "allMailboxes": "false",

   "lastStatus": "Success",

   "lastRun": "2017-04-01T10:12:15.3635382Z",

   "nextRun": "2017-04-01T22:00:00Z",

   "isEnabled": "true",

   "schedulePolicy": {

     "type": "Daily",

     "dailyType": "Sunday",

     "dailyTime": "08:00:00",

     "backupWindow": {

       "backupIntervalsArray": [

         true,

         true,

         true,

         ...

       ],

       "minuteOffset": 0

     },

    "retryEnabled": "true",

    "retryNumber": 5,

    "retryWaitInterval": 15

  },

   "_links": {

     "self": {

       "href": "https://support.east.local:4443/v1/Jobs/93089cfa-81d6-4551-8a7b-a7290868d6f9"

     },

     "organization": {

       "href": "https://support.east.local:4443/v1/Organizations/357c6d0d-70b7-4c59-8285-76be5ac9c136"

     },

     "repository": {

       "href": "https://support.east.local:4443/v1/BackupRepositories/035bcd44-6f68-4335-b6b8-4e22452eb8ff"

     },

         "proxy": {

       "href": "https://support.east.local:4443/v1/Proxies/5a905bb5-9071-433c-9d2f-f805d4da2cf4"

     },

     "selectedMailboxes": {

       "href": "https://support.east.local:4443/v1/Jobs/93089cfa-81d6-4551-8a7b-a7290868d6f9/SelectedMailboxes"

     },

     "jobsessions": {

       "href": "https://support.east.local:4443/v1/Jobs/93089cfa-81d6-4551-8a7b-a7290868d6f9/JobSessions"

     }

   }

 }

Related Topics

Backup of Organizational Mailboxes

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference