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

(GET) /Jobs/{ID}/ExcludedMailboxes

Returns a resource representation of the organization mailboxes that are excluded from the scope of a backup job.

Request

To get a resource representation of the processed mailboxes by the backup job, send the GET HTTPS request to the URL of the /Jobs/{ID}/ExcludedMailboxes resource:

HTTPS Request

GET https://<Backup-Office365>:<Port>/v1/Jobs/{ID}/ExcludedMailboxes

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

None.

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

In the response body, the server returns a representation of the /Jobs/{ID}/ExcludedMailboxes resource.

Example

The following request returns an entity representation of the mailboxes excluded from the scope of the backup job with ID 4ac92bac-a27e-4479-847c-d7cfead24a8a.

Request:

GET https://support.east.local:4443/v1/Jobs/4ac92bac-a27e-4479-847c-d7cfead24a8a/ExcludedMailboxes

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "results": [

     "id": "479ae6aa-610b-4652-8966-5db06021903c",

     "email": "petep@eastsupport.onmicrosoft.com",

     "name": "Peter Parker",

     "isBackedUp": "false",

     "_links": {

       "self": {

         "href": "https://support.east.local:4443/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/Mailboxes/479ae6aa-610b-4652-8966-5db06021903c"

       },

       "organization": {

         "href": "https://support.east.local:4443/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b"

       }

     }

   },

   {

     "id": "d38fbc9f-e856-4bc2-8ded-3e92adde2360",

     "email": "pgraham@eastsupport.onmicrosoft.com",

     "name": "Paul Graham",

     "isBackedUp": "false",

     "_links": {

       "self": {

         "href": "https://support.east.local:4443/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b/Mailboxes/d38fbc9f-e856-4bc2-8ded-3e92adde2360"

       },

       "organization": {

         "href": "https://support.east.local:4443/v1/Organizations/7b2b1ae1-7bbb-4651-b479-bda7edc7838b"

       }

     }

   },

...],

"_links": {

   "self": {

     "href": "https://support.east.local:4443/v1/jobs/4ac92bac-a27e-4479-847c-d7cfead24a8a/ExcludedMailboxes?offset=0&limit=30"

   }

 }

}

Related Topics

Backup of Organizational Mailboxes

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference