Getting Backup Jobs

This section explains how to 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 parameters must be posted as URL.

Parameter	Type	Description
jobId	string	An identification number of the backup job.

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

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
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	int	Specifies the number of attempts to run the backup job.
RetryWait Interval	int	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	int	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 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.

Example

Request:

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

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

{

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

"name": "test_job",

"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,

"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"

}