Getting Backup Job Sessions

This section explains how to get a resource representation of a collection of all sessions created for backup jobs.

Request

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

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 representation of the /JobSessions collection resource.

Example

The following request returns an entity representation of all job sessions in Veeam Backup for Microsoft Office 365.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

   {

     "id": "6a3fa2fb-3a77-4d99-8b5d-b6bd4102ffb1",

     "creationTime": "2020-12-13T22:00:00.5852401Z",

     "endTime": "2020-12-13T22:02:17.6515649Z",

     "progress": 18,

     "status": "Success",

     "statistics": {

       "processingRateBytesPS": 71012,

       "processingRateItemsPS": 9,

       "readRateBytesPS": 247870,

       "writeRateBytesPS": 2184,

       "transferredDataBytes": 63570500,

       "processedObjects": 377,

       "bottleneck": "Target"

     },

     "_links": {

       "self": {

         "href": "https://abc.tech.local:4443/v5/jobsessions/6a3fa2fb-3a77-4d99-8b5d-b6bd4102ffb1"

       },

       "log": {

         "href": "https://abc.tech.local:4443/v5/jobsessions/6a3fa2fb-3a77-4d99-8b5d-b6bd4102ffb1/logitems"

       },

       "job": {

         "href": "https://abc.tech.local:4443/v5/jobs/196e4df2-0faf-4b8e-ba17-ce8c0eb4edc5"

       }

     }

   },

...

 ],
 "_links": {
   "self": {
     "href": "https://abc.tech.local:4443/v5/JobSessions?offset=0&limit=30"
   },
   "next": {
     "href": "https://abc.tech.local:4443/v5/JobSessions?offset=30&limit=30"
   }
 }
}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.