Editing Backup Job Retention Settings

In this article

    You can edit retention settings of a backup job sessions.

    Request

    PUT https://<hostname>:4443/v5/HistorySettings

    Request Headers

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

    Request Body

    To edit job session retention settings, you need to enter in the request body the required properties with new values.

    The following table lists available request properties.

    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

    integer

    Specifies the retention period for job sessions in weeks.

    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:

    Request Body:

    {

     "keepAllsessions": false,

     "keeponlyLast": 4

    }

    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

    None.

    Examples

    Example 1

    The example below shows how to update the job session retention settings.

    Request:

    PUT https://abc.tech.local:4443/v5/HistorySettings

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "keepAllsessions": false,

     "keeponlyLast": 4

    }

     

    Response:

    200 OK

    I want to report a typo

    There is a misspelling right here:

     

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