Getting Excluded Folders

This section explains how to get a list of excluded mailbox folders.

Request

GET https://<hostname>:4443/v4/ExclusionSettings

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

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.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

The example below returns an entity representation of mailbox exclusion settings configured for backup jobs.

Request:

GET https://abc.tech.local:4443/v4/ExclusionSettings

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "deletedItems": "false",

 "drafts": "true",

 "junkEmail": "true",

 "outbox": "true",

 "syncIssues": "true",

 "litigationHold": "true",

 "inPlaceHold": "true",

 "_links": {

   "self": {

     "href": "https://abc.tech.local:4443/v4/ExclusionSettings"

   }

 },

 "_actions": {

   "update": {

     "uri": "https://abc.tech.local:4443/v4/ExclusionSettings",

     "method": "PUT"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.