Editing Backup Job Settings

In this article

    You can edit a backup job with the specified ID.

    Request

    PUT https://<hostname>:4443/v6/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 request body must contain the following properties:

    Property

    Type

    Description

    name

    string

    Specifies the backup job name.

    description

    string

    Specifies the backup job description.

    backupType

    string

    Specifies the type of the backup job. The following types are available:

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

    repositoryId

    string

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

    runNow

    boolean

    If set to true, indicates that the job will run right after it is created.

    isEnabled

    boolean

    If set to true, indicates that the backup job is enabled.

    schedulePolicy

    Specify the following properties for the backup job schedule policy.

    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 backup job schedule type. The following types are available:

    • Daily. The backup job runs on specific days.
    • Periodically. The backup job runs repeatedly throughout a day with a specific time interval.
    • ManualOnly. The backup job runs manually.

    dailyType

    string

    Specifies the days when the backup job will run. The following values are available:

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

    dailyTime

    UTC

    Specifies the time to start the backup job.

    periodicallyEvery

    string

    Specifies the time interval between the job runs. The following values are available:

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

    scheduleEnabled

    boolean

    If set to true, indicates that a schedule feature is enabled for this job. Use this property only with the periodicallyEvery property and the time interval specified in hours.

    backupWindowSettings

    backupWindowSettings

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

    periodicallyWindowSettings

    periodicallyWindowSettings

    Specifies allowed and prohibited hours for the backup job to run. Use this property only with the periodicallyEvery property and the time interval specified in hours.

    periodicallyOffsetMinutes

    integer

    Specifies a number of minutes for which you want to shift starting of the backup job within an hour if several backup jobs are scheduled to be started simultaneously. Use this property only with the periodicallyEvery property and the time interval specified in hours.

    retryEnabled

    boolean

    If set to true, indicates that Veeam Backup for Microsoft 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 backup job retry attempts (in minutes).

    backupWindowSettings

    Specify the following properties for the backup window:

    Property

    Type

    Description

    backupWindow

    boolean[]

    Defines 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

    minuteOffset

    integer

    Specifies the current minute offset from the UTC time.

    periodicallyWindowSettings

    If you configure the backup job to run periodically every N hours, specify the following properties for the schedule:

    Property

    Type

    Description

    backupWindow

    boolean[]

    Defines an hourly scheme for the backup job to run. 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

    minuteOffset

    integer

    Specifies the current minute offset from the UTC time.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 204 No Content.

    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 shows how to change scheduling options for the backup job with the ID a387d9d9-5d02-4543-880a-c1c3c494eeda.

    Request:

    PUT https://abc.tech.local:4443/v6/Jobs/a387d9d9-5d02-4543-880a-c1c3c494eeda

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

        "schedulePolicy": {

        "scheduleEnabled": true,

        "backupWindowEnabled": true,

         "backupWindowSettings": {

           "backupWindow": [

             true,

             true,

             true,

             true,

             true,

             true,

             true,

             ...

             true,

             true,

             true,

             true,

             true,

             true

           ],

           "minuteOffset": 0

         },

         "periodicallyWindowSettings": {

           "backupWindow": [

             false,

             false,

             true,

             true,

           ...

             true,

             true,

             true,

             true,

             true

           ],

           "minuteOffset": 0

         },

         "periodicallyOffsetMinutes": 5,

         "type": "Periodically",

         "periodicallyEvery": "Hours2",

         "retryEnabled": true,

         "retryNumber": 3,

         "retryWaitInterval": 10

      },

     "runNow": true

    }

     

    Response:

    204 No Content