Veeam Backup for Microsoft Office 365 4.0
RESTful API Reference
Related documents

Editing Backup Job Settings

This section explains how to edit a backup job with the specified ID.

Request

PUT https://<hostname>:4443/v4/Jobs/{backup_job_id}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter

Type

Description

backup_job_id

string

An identification number of the backup job.

Request Body

The following table lists request parameters.

Property

Type

Description

Name

string

Specifies the name of the backup job.

Description

string

Specifies the description of the backup job.

BackupType

backupType

Specifies the type of the backup job:

  • entireOrganization
  • selectedItems

SchedulePolicy

SchedulePolicy

Specifies the backup job scheduling options.

ProxyId

string

Specifies the ID of the backup proxy.

RepositoryId

string

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

RunNow

bool

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

SchedulePolicy

Specify the properties listed below 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.

DailyType

string

Specifies the days when the backup job will run:

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

DailyTime

UTC

Specifies the time when the job will start.

PeriodicallyEvery

string

Specifies the time interval between the job runs:

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

BackupWindowEnabled

bool

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

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.

RetryNumber

int

Specifies the number of attempts to run the backup job.

RetryWait
Interval

int

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

For example:

 "schedulePolicy": {

    "type": "Daily",

    "dailyType": "Sunday",

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

    "backupWindowEnabled": true,

    "backupWindowSettings": {

      "backupWindow": [

         true,

         ..

       ],

     },

    "retryEnabled": "true",

    "retryNumber": 3,

    "retryWaitInterval": 10

}

BackupWindowSettings

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

Property

Type

Description

BackupWindow

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

MinuteOffset

int

Specifies the current minute offset from the UTC time.

For example:

 "backupWindowSettings": {

    "backupWindow": [

         true,

         true,

         true,

         ..

       ],

     }

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a 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 response 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://abc.tech.local:4443/v4/Jobs/70a8cbaf-642f-4c6f-934d-fb10e597a82a

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "id": "e1714f5b-e51b-496b-9e46-e7bf979aa6d6",

  "name": "test_job",

  "description": "",

  "lastRun": "2017-06-06T15:18:22.6664413Z",

  "nextRun": "2017-06-13T15:00:00Z",

  "isEnabled": true,

  "backupType": "SelectedItems",

  "lastStatus": "Success",

  "schedulePolicy": {

    "backupWindowEnabled": true,

    "backupWindowSettings": {

      "backupWindow": [

        true,

        true,

        true,

         ..

      ],

      "minuteOffset": 0

    },

    "type": "Daily",

    "dailyType": "Wednesday",

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

    "retryEnabled": true,

    "retryNumber": 3,

    "retryWaitInterval": 10

  },

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

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

 "RunNow": "true"

}

 

Response:

200 OK

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.