mailboxRestoreRequests

Mailbox Restore Jobs. Jobs that restore content from soft-deleted or disconnected mailboxes. The mailboxRestoreRequests entity set lives under /exchange/v1.0/mailboxRestoreRequests in the Migration & jobs category.

Fact	Value
Path	/exchange/v1.0/mailboxRestoreRequests
Category	Migration & jobs
Tier	Tier 6, Mailbox jobs
Read role	MailboxJobs.Read.All (Community)
Write role	none (read-only)
Backing cmdlets	Get-MailboxRestoreRequest, Set-MailboxRestoreRequest, New-MailboxRestoreRequest, Remove-MailboxRestoreRequest, Resume-MailboxRestoreRequest, Suspend-MailboxRestoreRequest, Get-MailboxRestoreRequestStatistics

Routes

Method	Path	Synopsis	Role	Plan
GET	/exchange/v1.0/mailboxRestoreRequests	List mailboxRestoreRequests entries.	MailboxJobs.Read	Community
GET	/exchange/v1.0/mailboxRestoreRequests/{key}	Get a single mailboxRestoreRequests entry by Identity.	MailboxJobs.Read	Community
GET	/exchange/v1.0/mailboxRestoreRequests/{key}/statistics	Get-MailboxRestoreRequestStatistics - per-restore-request progress.	MailboxJobs.Read	Community

GET /exchange/v1.0/mailboxRestoreRequests

List mailboxRestoreRequests entries.

Backing cmdlet: Get-MailboxRestoreRequest. Role: MailboxJobs.Read (Community).

Parameter	In	Type	Required	Description
status	query	string		Filter requests by status (Get-MailboxRestoreRequest -Status). One of: AutoSuspended, Completed, CompletedWithWarning, CompletionInProgress, Failed, InProgress, Queued, Retrying, Suspended, Synced.
targetMailbox	query	string		Find all restore requests targeting a specific mailbox (Get-MailboxRestoreRequest -TargetMailbox). Accepts GUID, DN, UPN, SMTP address, or alias.
all	query	bool (switch)		Return all results instead of the EXO default of 1000. Maps to -ResultSize Unlimited on Get-MailboxRestoreRequest; prevents silent truncation in large tenants.
batchName	query	string
suspend	query	bool (switch)
highPriority	query	bool (switch)
name	query	string

List mailboxRestoreRequests

Stub auto-generated example for the mailboxRestoreRequests collection. Backing cmdlet: Get-MailboxRestoreRequest. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/mailboxRestoreRequests?$top=3 HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxRestoreRequests",
  "value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailboxRestoreRequests/{key}

GET /exchange/v1.0/mailboxRestoreRequests/{key}

Get a single mailboxRestoreRequests entry by Identity.

Backing cmdlet: Get-MailboxRestoreRequest. Role: MailboxJobs.Read (Community).

Get a single mailboxRestoreRequests entry

Stub auto-generated example for GET /mailboxRestoreRequests/{key}. Backing cmdlet: Get-MailboxRestoreRequest with -Identity {key}. Returns the full entity body; 404 if the identity doesn’t resolve.

GET /exchange/v1.0/mailboxRestoreRequests/{key} HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxRestoreRequests/$entity"
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailboxRestoreRequests

GET /exchange/v1.0/mailboxRestoreRequests/{key}/statistics

Get-MailboxRestoreRequestStatistics - per-restore-request progress.

Backing cmdlet: Get-MailboxRestoreRequestStatistics. Role: MailboxJobs.Read (Community).