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

Getting Backup Jobs

You can get a list of configured backup jobs.

Request

GET https://<hostname>:4443/v5/Jobs

Request Headers

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

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

In the response body, the server returns a resource representation of the /Jobs collection resource.

Examples

Example 1

Request:

GET https://abc.tech.local:4443/v5/Jobs

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response 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

   },

   "_links": {

     "self": {

       "href": "https://abc.tech.local:4443/v5/jobs/e1714f5b-e51b-496b-9e46-e7bf975aa6d6"

     },

     "organization": {

       "href": "https://abc.tech.local:4443/v5/organizations/ae1a5622-7fb2-49ec-b7b2-393da59fbed2"

     },

     "backupRepository": {

       "href": "https://abc.tech.local:4443/v5/backuprepositories/83846d9a-d468-497e-b524-ab5ec782b607"

     },

     "jobsessions": {

       "href": "https://abc.tech.local:4443/v5/jobs/e1714f5b-e51b-496b-9e46-e7bf379aa6d6/jobsessions"

     },

     "excludedItems": {

       "href": "https://abc.tech.local:4443/v5/jobs/e1714f5b-e51b-496b-9e46-e7bf979ba6d6/excludedItems"

     },

     "selectedItems": {

       "href": "https://abc.tech.local:4443/v5/jobs/e1714f5b-e51b-496b-9e46-e7bf949ga6d6/selectedItems"

     }

   }

 }

]