Getting Excluded Folders

In this article

    You can get a list of the excluded mailbox folders.

    Request

    GET https://<hostname>:4443/v5/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

    The response contains the following information:

    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).

    Examples

    Example 1

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

    Request:

    GET https://abc.tech.local:4443/v5/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/v5/ExclusionSettings"

       }

     },

     "_actions": {

       "update": {

         "uri": "https://abc.tech.local:4443/v5/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.