Editing Exclusion Settings
This section explains how to edit a list of excluded mailbox folders.
Request
PUT https://<hostname>:4443/v4/ExclusionSettings |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
To edit the backup exclusion settings, you need to enter in the request body the corresponding properties with new values. The properties you omit will remain unchanged.
The following table lists available request parameters.
Property | Type | Description |
|---|---|---|
DeletedItems | boolean | Indicates that backup jobs will not process Deleted Items mailbox folder. |
Drafts | boolean | Indicates that backup jobs will not process Drafts mailbox folder. |
JunkEmail | boolean | Indicates that backup jobs will not process Junk email mailbox folder. |
Outbox | boolean | Indicates that backup jobs will not process Outbox mailbox folder. |
SyncIssues | boolean | Indicates that backup jobs will not process Sync Issues mailbox folder. |
LitigationHold | boolean | Indicates that backup jobs will not process preserved items of mailboxes placed on Litigation Hold. |
InPlaceHold | boolean | Indicates that backup jobs will not process preserved items of mailboxes placed on In-Place Hold. |
Request Example
{ "deletedItems": "true", "drafts": "false", "junkEmail": "false", "outbox": "false", "syncIssues": "false", "litigationHold": "true", "inPlaceHold": "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.
Example
The example below shows how to update the backup exclusion settings.
Request: PUT https://abc.tech.local:4443/v4/ExclusionSettings
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "deletedItems": "true", "drafts": "false", "junkEmail": "false", "outbox": "false", "syncIssues": "false", "litigationHold": "true", "inPlaceHold": "true" }
Response: 200 OK |
