This is an archive version of the document. To get the most up-to-date information, see the current version.

Editing Backup Job Settings

You can edit a backup job with the specified ID.

Request

PUT https://<hostname>:4443/v5/Jobs/{jobId}

Request Headers

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

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter	Type	Description
jobId	string	Specifies the identification number of the backup job. For more information on how to get this parameter, see Getting Backup Jobs.

Request Body

The following table lists available request properties:

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 Note: For the backup job of the selectedItems type, you must specify a collection of objects you want to back up. For more information about properties that you must specify for different types of backup and excluded items, see backupitemType and excludeditemType.
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	boolean	If set to true, the job will run right after it is created.

schedulePolicy

Specify the following 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.
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	boolean	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	boolean	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	integer	Specifies the number of attempts to run the backup job.
retryWaitInterval	integer	Specifies the time intervals between the job retry attempts (minutes).

For example:

Request Body:

"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	boolean	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	integer	Specifies the current minute offset from the UTC time.

Property

Type

Description

backupWindow

boolean

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: