Editing Backup Repository Settings

In this article

    You can edit a backup repository with the specified ID.

    Request

    PUT https://<hostname>:4443/v5/BackupRepositories/{repositoryId}

    Request Headers

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

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    repositoryId

    string

    Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories.

    Request Body

    To edit repository settings, you need to enter in the request body the required properties with new values. The properties you omit will remain unchanged.

    The following table lists available request properties:

    Property

    Type

    Description

    name

    string

    Specifies the name you want to assign to the backup repository.

    description

    string

    Specifies the description of the backup repository.

    retentionPeriodType

    string

    Specifies the retention period type:

    • Daily
    • Monthly
    • Yearly

    dailyRetentionPeriod

    string

    Specifies the retention period in days. This property is valid if retentionPeriodType is set to Daily.

    monthlyRetentionPeriod

    string

    Specifies the retention period in months. This property is valid if retentionPeriodType is set to Monthly.

    yearlyRetentionPeriod

    string

    Specifies the retention period in years:

    • Year1
    • Years2
    • Years3
    • Years5
    • Years7
    • Years10
    • Years25
    • Keep

    This property is valid if retentionPeriodType is set to Yearly.

    If you select Keep, the backup job will back up all items in the mailbox and will never remove them.

    retentionFrequencyType

    string

    Specifies clean-up schedule type:

    • Daily: to check and remove the outdated backups once a day. Use dailyTime property to set the time of the day for performing clean-up. Use dailyType property to set the days for performing clean-up.
    • Monthly: to check and remove the outdated backups once a month. Use monthlyTime property to set the time of the day for performing clean-up. Use monthlyDayNumber and monthlyDayOfWeek properties to set the day for performing clean-up.

    dailyTime

    UTC

    For daily clean-up schedule.

    Specifies the time of the day when clean-up must be performed.

    dailyType

    string

    For daily clean-up schedule.

    Specifies the days when clean-up must be performed:

    • Sunday
    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Everyday
    • Workdays
    • Weekends

    monthlyTime

    UTC

    For monthly clean-up schedule.

    Specifies the time of the day when clean-up must be performed.

    monthlyDayNumber

    string

    For monthly clean-up schedule.

    Specifies the order number for the day of the week when clean-up must be performed:

    • First
    • Second
    • Third
    • Fourth
    • Last

    monthlyDayOfWeek

    string

    For monthly clean-up schedule.

    Specifies the day of the week when clean-up must be performed:

    • Sunday
    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday

    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 shows how to update the backup repository settings with the ID 5729d9cf-abfa-4077-9dd5-f5a888b98147.

    Request:

    PUT https://abc.tech.local:4443/v5/BackupRepositories/5729d9cf-abfa-4077-9dd5-f5a888b98147

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "name": "ABC Support Monthly",

     "retentionPeriodType": "Monthly",

     "monthlyRetentionPeriod": "6",

     "retentionFrequencyType": "Monthly",

     "description": "Monthly Reports",

     "monthlyTime": "00:00:00",

     "monthlyDaynumber": "Last",

     "monthlyDayofweek": "Sunday"

    }

     

    Response:

    200 OK