Search for Backed-Up Items
The Veeam Backup for Microsoft 365 REST API allows you to search for items in backups of Microsoft 365 organization data. You can perform the following search operations:
- Search for Microsoft Exchange items in backed-up organizations, mailboxes and mailbox folders.
- Search for Microsoft OneDrive for Business items in entire OneDrive storage and specific OneDrive folders.
- Search for Microsoft SharePoint items in backed-up SharePoint sites, folders, libraries and lists.
- Search for Microsoft Teams items in backed-up organizations, teams and channels.
To search for items, use a POST HTTPS request of the following format:
POST https://<hostname>:<Port>/v8/<path_to_resource>/search |
where <path_to_resource> is a path to the resource that represents an object (for example, a mailbox, folder, site, library, list or team) where you want to search for backed-up items.
In the body of the request, provide the search action property with query parameters that define search criteria. Available query parameters differ for different type of items: Exchange items, SharePoint items and OneDrive for Business items or Teams items.
For more information about request syntax and query parameters for specific search operations, see the following sections of the Veeam Backup for Microsoft 365 REST API Reference:
Search for Microsoft Exchange Items:
- Search for Exchange Items in Organization Backups
- Search for Exchange Items in Mailboxes
- Search for Exchange Items in Mailbox
- Search for Exchange Items in Mailbox Folder
Search for Microsoft OneDrive Items:
- Search for OneDrive Items in OneDrives
- Search for OneDrive Items in OneDrive
- Search for OneDrive Items in OneDrive Folder
Search for Microsoft SharePoint Items:
- Search for SharePoint Items in SharePoint Sites
- Search for SharePoint Items in SharePoint Site
- Search for SharePoint Documents in SharePoint Folder
- Search for SharePoint Documents in SharePoint Library
- Search for SharePoint Items in SharePoint List
Search for Microsoft Teams Items:
- Search for Teams Items In Organization Backups
- Search for Teams Items in Team
- Search for Teams Items in Channel
- Search for Tabs
- Search for Files
- Search for Posts
|
For search of Microsoft 365 items, Veeam Backup for Microsoft 365 uses the Windows Search functionality. In a query string provided in the body of a search request, you can specify search parameters in the form of canonical names (for example, System.Message.FromAddress and System.Message.ToAddress) or their shortcuts (for example, from and to). For a full list of search parameters supported in Veeam Backup for Microsoft 365, see the Appendix A. Item Search Parameters section of the Veeam Backup for Microsoft 365 User Guide. |
The following example shows a request used to search for email messages in a mailbox. The request is used to search for messages sent from a specified sender to a specified recipient.
Request: POST https://abc.tech.local:4443/v8/RestoreSessions/b0af6a38-d39e-4a6f-97e4-7a15d67bf5cc/organization/mailboxes/4e4c1ad9-85ae-457d-b806-7a98cb27975d/search
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "query": "from: user_X to: user_Y" } |