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

(PUT) /Jobs/{ID}

Edits a backup job with the specified ID.

Request

To edit settings of a backup job, send the PUT HTTPS request to the URL of the /Jobs/{ID} resource.

HTTPS Request

PUT https://<Backup-Office365>:<Port>/v1/Jobs/{ID}

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

To edit backup job settings, you need to enter in the request body the corresponding properties with new values.

The request body can contain the following properties:

Property

Type

Description

Name

string

Specifies the name of the backup job.

For example, "name": "Daily".

Description

string

Specifies the description of the backup job.

For example, "description": "ABC".

AllMailboxes

bool

True: indicates that the backup job will back up all mailboxes of the associated organization. To exclude certain mailboxes from the backup scope, set the ExcludedMailboxes property.

False: indicates that the backup job will back up only the selected mailboxes. To add the array of mailboxes to the backup scope, set the SelectedMailboxes property.

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.

SchedulePolicy

SchedulePolicy

Specifies the backup job scheduling options.

ProxyId

string

Specifies the ID of the backup proxy where the repository with backups is located.

For example, "proxyId": "5a905bb5-9071-433c-9d2f-f805d4da2cf4".

RepositoryId

string

Specifies the ID of the repository where the mailbox backups will be stored.

For example, "repositoryId": "a740fb93-4de8-4de4-977e-765dd092748f".

IsRun

bool

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

For example, "IsRun": "true".

ExcludedMailboxes

Specifies the array of mailboxes you want to exclude from the backup scope. The following mailbox properties must be defined:

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"

For example:

"allMailboxes": "true",

  "excludedMailboxes": [

    {

      "id": "ac57ab24-e4b2-4c47-a3da-43fd612323dc",

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

      "name": "Peter Parker",

     },

     {

      "id": "1dfcbe30-4b44-4c6f-80f4-bd2b8a0caf8d",

      "email": "smunez@eastsupport.onmicrosoft.com",

      "name": "Santiago Munez",

     },

 ...]

SelectedMailboxes

Specifies the array of mailboxes you want to add to the backup scope. The following mailbox properties must be defined:

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"

For example:

"allMailboxes": "false",

  "selectedMailboxes": [

    {

      "id": "fa89f7b9-42c8-4f55-aa3b-b1dbfb6de9b2",

      "email": "jsmith@eastsupport.onmicrosoft.com",

      "name": "John Smith",

     },

     {

      "id": "cfb59313-3fa0-4585-a7ce-0e6d06f682c4",

      "email": "etysom@eastsupport.onmicrosoft.com",

      "name": "Erika Tysom",

    },

...]

SchedulePolicy

Specify the below listed properties for the backup job schedule.

Mind that the Type property must be specified if you want to enter the new values for the DailyType, DailyTime or PeriodicallyEvery 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.

For example:

 "schedulePolicy": {

    "type": "Daily",

    "dailyType": "Sunday",

    "dailyTime": "18:00:00",

    "backupWindow": {

      "backupIntervalsArray": [

         true,

         ...

       ],

     },

    "retryEnabled": "true",

    "retryNumber": 3,

    "retryWaitInterval": 10

}

BackupWindow

Specify the following property for the job's backup window:

Property

Type

Description

BackupIntervalsArray

bool

Specifies an hourly scheme for the backup window. The scheduling scheme consists of 168 boolean type 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.

For example:

 "backupWindow": {

    "backupIntervalsArray": [

         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,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false,

         false

       ],

     }

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

None.

Example

The example below shows how to exclude mailboxes from the scope of a backup job with ID 70a8cbaf-642f-4c6f-934d-fb10e597a82a.

Request:

PUT https://support.east.local:4443/v1/Jobs/70a8cbaf-642f-4c6f-934d-fb10e597a82a

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "name": "Daily",

 "description": "ABC",

 "allmailboxes": "true",

  "excludedMailboxes": [

    {

      "id": "ac57ab24-e4b2-4c47-a3da-43fd612323dc",

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

      "name": "Peter Parker",

     }

    ],

 "schedulePolicy": {

    "type": "Daily",

    "dailyType": "Sunday",

    "dailyTime": "18:00:00",

    "backupWindow": {

      "backupIntervalsArray": [

         true,

         true,

         true,

         ...

       ],

   },

    "retryEnabled": "true",

    "retryNumber": 3,

    "retryWaitInterval": 10

 },

 "proxyId": "5a905bb5-9071-433c-9d2f-f805d4da2cf4",

 "repositoryId": "a740fb93-4de8-4de4-977e-765dd092748f",

 "isRun": "true"

}

 

Response:

200 OK

Related Topics

Managing Jobs

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference