Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
RESTful API Reference

(PUT) /ExclusionSettings

Edits backup exclusion settings.

Request

To edit backup exclusion settings, send the PUT HTTPS request to the URL of the /ExclusionSettings resource.

HTTPS Request

PUT https://<Backup-Office365>:4443/v2/ExclusionSettings

Request Headers

The request contains the following headers:

Header

Required

Description

Content-Type: application/json

true

Specifies the type of the content for your request.

Authorization: Bearer <Access-Token>

true

The request header must contain the authorization token for the current logon 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 request body can contain the following properties:

Property

Type

Description

DeletedItems

bool

Indicates that backup jobs will not process Deleted Items mailbox folder.

For example, "deletedItems": "false".

Drafts

bool

Indicates that backup jobs will not process Drafts mailbox folder.

For example, "drafts": "false".

JunkEmail

bool

Indicates that backup jobs will not process Junk email mailbox folder.

For example, "junkEmail": "false".

Outbox

bool

Indicates that backup jobs will not process Outbox mailbox folder.

For example, "outbox": "false".

SyncIssues

bool

Indicates that backup jobs will not process Sync Issues mailbox folder.

For example, "syncIssues": "true".

Litigation
Hold

bool

Indicates that backup jobs will not process preserved items of mailboxes placed on Litigation Hold.

For example, "litigationHold": "true".

InPlace
Hold

bool

Indicates that backup jobs will not process preserved items of mailboxes placed on In-Place Hold.

For example, "inPlaceHold": "true".

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

Request:

PUT https://support.east.local:4443/v2/ExclusionSettings

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Request Body:

{

 "deletedItems": "true",

 "drafts": "false",

 "junkEmail": "false",

 "outbox": "false",

 "syncIssues": "false",

 "litigationHold": "true",

 "inPlaceHold": "true"

}

 

Response:

200 OK

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference