Getting Mailbox Data by Repository ID

You can get a collection of backed-up or archived mailboxes whose data is stored in a backup repository with the specified ID.

Request

GET https://<hostname>:4443/v6/BackupRepositories/{repositoryId}/MailboxData

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter

Type

Description

repositoryId

string

Specifies the identification number of the backup repository. For more information on how to get this parameter, see Getting Backup Repositories.

The following optional parameters can be specified in the URL of the request:

Parameter

Type

Description

organizationId

string

Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

pointInTime

UTC

Specifies point in time that you want to get from a backup repository.

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

In the response body, the server returns a resource representation of the /BackupRepositories/{repositoryId}/MailboxData collection resource.

Example

The example returns a resource representation of mailboxes whose backed-up or archived data is stored in the backup repository with the ID 79f3e494-4991-4dd5-b6fa-f1cf8c421265.

Request:

GET https://abc.tech.local:4443/v6/BackupRepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/MailboxData

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "offset": 0,

 "limit": 30,

 "_links": {

   "self": {

     "href": "/v6/BackupRepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/MailboxData?offset=0&limit=30"

   }

 },

 "results": [

   {

     "id": "02002fc2-b6eb-4e9d-90c0-b13b215222c8",

     "isArchive": false,

     "displayName": "User1",

     "email": "user1@abc.onmicrosoft.com",

     "backedUpTime": "2022-01-27T18:07:50.0930091Z",

     "organizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "_links": {

       "self": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/mailboxdata/02002fc2-b6eb-4e9d-90c0-b13b215222c8"

       },

       "organization": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/organizationdata/abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"

       },

       "backupRepository": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

       }

     }

   },

   {

     "id": "062bc84d-d627-4acb-8ecd-b7cfa20c998c",

     "isArchive": false,

     "displayName": "User2",

     "email": "user2@abc.onmicrosoft.com",

     "backedUpTime": "2022-01-26T20:06:53.8548248Z",

     "organizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "_links": {

       "self": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/mailboxdata/062bc84d-d627-4acb-8ecd-b7cfa20c998c"

       },

       "organization": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/organizationdata/abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"

       },

       "backupRepository": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

       }

     }

   },

   {

     "id": "0d468d74-9dfa-41e8-b518-67565296167b",

     "isArchive": true,

     "displayName": "In-Place Archive - User3",

     "email": "user3@abc.onmicrosoft.com",

     "backedUpTime": "2022-01-26T22:05:21.9540223Z",

     "organizationId": "abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000",

     "_links": {

       "self": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/mailboxdata/0d468d74-9dfa-41e8-b518-67565296167b"

       },

       "organization": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/organizationdata/abc.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000"

       },

       "backupRepository": {

         "href": "/v6/backuprepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265"

       }

     }

   },

...

],

 "setId": "00000000-0000-0000-0000-000000000000"

}