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

Editing Exclusion Settings

You can edit a list of items that have been excluded from the retention policy.

Request

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

Request Headers

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

Request Body

The following table lists available request properties:

Property

Type

Description

contacts

boolean

Indicates whether to exclude the Contacts folder from the retention policy list.

calendar

boolean

Indicates whether to exclude the Calendar from the retention policy list.

For example:

Request Body:

{

  "contacts": false,

  "calendar": true

}

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 exclusion settings.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Request Body:

{

  "contacts": false,

  "calendar": true

}

 

Response:

200 OK