Getting Mailbox Data by Repository and Mailbox ID

In this article

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

    Request

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

    Request Headers

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

    Request Parameters

    The following parameters 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.

    mailboxId

    string

    Specifies the identification number of the mailbox. For more information on how to get this parameter, see Getting Mailbox Data by Repository ID.

    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 body contains the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the mailbox ID.

    isArchive

    boolean

    If set to true, indicates that the mailbox is of the Archive type.

    displayName

    string

    Specifies a display name of the backed-up or archived mailbox.

    email

    string

    Specifies the mailbox email.

    backedUpTime

    UTC

    Specifies date and time when the mailbox was backed up.

    organizationId

    string

    Specifies the backed-up organization ID.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Example

    The example returns a resource representation of the mailbox with the ID 0d468d74-9dfa-41e8-b518-67565296167b.

    Request:

    GET https://abc.tech.local:4443/v6/BackupRepositories/79f3e494-4991-4dd5-b6fa-f1cf8c421265/MailboxData/0d468d74-9dfa-41e8-b518-67565296167b

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

     {

     "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"

       }

     }

    }