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

Getting Job Sessions History Settings

You can get a resource representation with the history settings of backup and backup copy job sessions.

Request

GET https://<hostname>:4443/v6/HistorySettings

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

The response body contains the following properties:

Property

Type

Description

keepAllsessions

boolean

If set to true, indicates that Veeam Backup for Microsoft 365 will keep backup and backup copy job sessions forever. Otherwise, the job sessions will be kept during 53 weeks by default.

keeponlyLast

integer

Specifies the number of weeks during which backup and backup copy job sessions will be kept.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

_actions

Dictionary of string [key] and Object [value]

Links to related actions (navigation property).

Example

The example returns a resource representation with the history settings of backup and backup copy job sessions.

Request:

GET https://abc.tech.local:4443/v6/HistorySettings

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "keepAllsessions": false,

 "keeponlyLast": 4,

 "_links": {

   "self": {

     "href": "/v6/historysettings"

   }

 },

 "_actions": {

   "update": {

     "uri": "v6/historysettings",

     "method": "PUT"

   }

 }

}