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

(PUT) /BackupRepositories/{repositoryId}

In this article

Edits a backup repository having a specified ID.

Request

To edit the settings of a backup repository, send the PUT HTTPS request to the URL of the BackupRepositories/{repositoryId} resource:

HTTPS Request

PUT https://<Backup-Office365>:4443/v3/BackupRepositories/{repositoryId}

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

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

The request body can contain the following properties:

Property	Type	Description
Name	string	Specifies the name you want to assign to the backup repository. For example, "name": "ABC Support Monthly".
Description	string	Specifies the description of the backup repository. For example, "description": "Monthly Reports".
Retention Period Type	string	Specifies the retention period type: Daily Monthly Yearly For example, "retentionPeriodType": "Monthly".
Daily Retention Period	string	Specifies the retention period in days. This property is valid if retentionPeriodType is set to Daily. For example, "dailyRetentionPeriod": "14".
Monthly Retention Period	string	Specifies the retention period in months. This property is valid if retentionPeriodType is set to Monthly. For example, "monthlyRetentionPeriod": "6".
Yearly Retention Period	string	Specifies the retention period in years: Year1 Years2 Years3 Years5 Years7 Years10 Years25 KeepForever This property is valid if retentionPeriodType is set to Yearly. If you select KeepForever, the backup job will back up all items in the mailbox and will never remove them. For example, "yearlyRetentionPeriod": "KeepForever".
Retention Frequency Type	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. For example, "retentionFrequencyType": "Monthly".
DailyTime	UTC	For daily clean-up schedule. Specifies the time of the day when clean-up must be performed. For example, "dailyTime": "08:00:00".
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 For example, "dailyType": "Workdays".
MonthlyTime	UTC	For monthly clean-up schedule. Specifies the time of the day when clean-up must be performed. For example, "monthlyTime": "00:00:00".
Monthly DayNumber	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 For example, "monthlyDayNumber": "Last".
Monthly DayOfWeek	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 For example, "monthlyDayOfWeek": "Sunday".

For example:

{

"name": "ABC Support Monthly",

"retentionPeriodType": "Monthly",

"monthlyRetentionPeriod": "6",

"retentionFrequencyType": "Monthly",

"description": "Monthly Reports",

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

"monthlyDaynumber": "Last",

"monthlyDayofweek": "Sunday"

}

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

Request:

PUT https://support.east.local:4443/v3/BackupRepositories/5729d9cf-abfa-4077-9dd5-f5a888b98147

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{