Getting Backup Jobs

In this article

    You can get a resource representation of a backup job with the specified ID.

    Request

    GET 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

    None.

    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

    The response contains the following information:

    Property

    Type

    Description

    id

    string

    Specifies the ID of the backup job.

    name

    string

    Specifies the name of the backup job.

    description

    string

    Specifies the description of the backup job.

    lastStatus

    string

    Specifies the latest status of the backup job:

    • Stopped
    • Running
    • Success
    • Warning
    • Failed
    • Disconnected
    • NotConfigured
    • Queued

    lastRun

    UTC

    Specifies the time of the last run of a backup job.

    nextRun

    UTC

    Specifies the time of the next run of a backup job per the backup job schedule.

    isEnabled

    boolean

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

    backupType

    backupType

    Specifies the type of the backup job:

    • selectedItems
    • entireOrganization

    schedulePolicy

    schedulePolicy

    Specifies the backup job scheduling options.

    runNow

    boolean

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

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    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.

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

    backupWindowSettings

    The job's backup window has the following properties:

    Property

    Type

    Description

    backupWindow

    boolean

    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

    minuteOffset

    integer

    Specifies the current minute offset from the UTC time.

    Examples

    Example 1

    Request:

    GET https://abc.tech.local:4443/v5/Jobs/{jobId}

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

     "id": "3c407448-4d05-432f-a651-144827bed5ce",

     "name": "job office 365",

     "description": "",

     "lastRun": "2018-05-30T12:19:14.7927466Z",

     "nextRun": "2018-06-02T02:00:00Z",

     "isEnabled": true,

     "backupType": "selectedItems",

     "lastStatus": "Success",

     "schedulePolicy": {

       "backupWindowEnabled": true,

       "backupWindowSettings": {

         "backupWindow": [

           true,

           true,

           true,

           ..

         ],

         "minuteOffset": 0

       },

       "type": "Daily",

       "dailyType": "Friday",

       "dailyTime": "19:00:00",

       "retryEnabled": false

     },

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/jobs/3c407448-4d05-432f-a651-144827bed5ce"

       },

       "organization": {

         "href": "https://abc.tech.local:4443/v5/organizations/63e92db4-8c0a-46df-ba92-15f46011c4a5"

       },

       "backupRepository": {

         "href": "https://abc.tech.local:4443/v5/backuprepositories/ce19de31-329d-4f0f-b85e-4424cc2e6821"

       },

       "jobsessions": {

         "href": "https://abc.tech.local:4443/v5/jobs/3c407448-4d05-432f-a651-144827bed5ce/jobsessions"

       },

       "excludedItems": {

         "href": "https://abc.tech.local:4443/v5/jobs/3c407448-4d05-432f-a651-144827bed5ce/excludedItems"

       },

       "selectedItems": {

         "href": "https://abc.tech.local:4443/v5/jobs/3c407448-4d05-432f-a651-144827bed5ce/selectedItems"

       }

     }

    }