This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Backup Job Retention Settings
This section explains how to get a resource representation about retention settings of a backup job sessions.
Request
GET https://<hostname>:4443/v4/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
Property | Type | Description |
|---|---|---|
KeepAllsessions | boolean | If set to True, indicates that Veeam Backup for Microsoft Office 365 will keep job sessions forever. Otherwise, the job sessions will be kept according to the default retention period (53 weeks). |
KeeponlyLast | int | Specifies the retention period for job sessions in weeks. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example below returns an entity representation of retention settings for backup job sessions.
Request: GET https://abc.tech.local:4443/v4/HistorySettings
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "keepAllsessions": "false", "keeponlyLast": 4, "_links": { "self": { "href": "https://abc.tech.local:4443/v4/historysettings" } }, "_actions": { "update": { "uri": "https://abc.tech.local:4443/v4/historysettings", "method": "PUT" } } } |