Getting Excluded Items

In this article

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

    Request

    GET https://<hostname>:4443/v5/Organizations/{organizationId}/RetentionExclusion

    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

    contacts

    boolean

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

    calendar

    boolean

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

    Examples

    Example 1

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

    Request:

    GET https://abc.tech.local:4443/v5/Organizations/4111916c-3a82-4b0b-8d92-13cc1c797bc7/RetentionExclusion

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

      "contacts": true,

      "calendar": true

    }

    I want to report a typo

    There is a misspelling right here:

     

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