Getting Excluded Items

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

Request

GET https://<hostname>:4443/v6/GlobalRetentionExclusionSettings

Request Headers

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

Request Body

None.

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

The response body contains the following properties:

Property

Type

Description

contacts

boolean

Defines that the Contacts folder will not be removed by the retention policy.

calendar

boolean

Defines that the Calendar will not be removed by the retention policy.

Example

The example returns a resource representation of mailbox exclusion settings configured for backup jobs.

Request:

GET https://abc.tech.local:4443/v6/GlobalRetentionExclusionSettings

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

  "contacts": true,

  "calendar": true

}