Edits retention settings for backup job sessions.
Specifies the period for which Veeam Backup for Microsoft Office 365 will keep job sessions data.
Request
To edit the retention settings for backup job sessions, send the PUT HTTPS request to the URL of the /HistorySettings resource.
HTTPS Request
PUT https://<Backup-Office365>:4443/v2/HistorySettings |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
Content-Type: application/json | true | Specifies the type of the content for your request. |
Authorization: Bearer <Access-Token> | true | The request header must contain the authorization token for the current logon session. |
Request Body
To edit job session retention settings, you need to enter in the request body the corresponding properties with new values.
The request body can contain the following properties:
Property | Type | Description |
|---|---|---|
Keep | bool | 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). For example, "keepAllsessions": "false". |
Keep | int | Specifies the retention period for job sessions in weeks. For example, "keeponlyLast": "4". |
If you want to set the retention period for job sessions in weeks, perform the following steps:
- Set the KeepAllsessions property to "false" value.
- Set the number of weeks for the KeeponlyLast property.
For example:
{ "keepAllsessions": "false", "keeponlyLast": 4 } |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns 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 request body message: application/json; charset=utf-8 |
Response Body
None.
Example
The example below shows how to update the job session retention settings.
Request: PUT https://support.east.local:4443/v2/HistorySettings
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body: { "keepAllsessions": "false", "keeponlyLast": 4 }
Response: 200 OK |
