Actions75
- EndpointAutopilot Actions
- TenantAdministrationAlerts Actions
- EndpointMEM Actions
- TenantGDAP Actions
- TenantAdministrationApplicationApproval Actions
- TenantAdministration Actions
- CIPPSetup Actions
- Security Actions
- IdentityAdministrationDevices Actions
- CIPPExtensions Actions
- EmailExchangeTools Actions
EmailExchangeTools → ListMailboxRestores
AI-generatedOverview
This node operation retrieves a list of mailbox restore requests from the Email Exchange Tools resource. It supports filtering by tenant domain and additional optional parameters such as identity, report inclusion, and statistics. The operation can return all results with pagination or a single page based on user preference. This is useful for administrators managing mailbox restore operations in an Exchange environment, allowing them to monitor and manage restore requests efficiently.
Use Case Examples
- An administrator wants to fetch all mailbox restore requests for a specific tenant to audit restore activities.
- A support engineer needs to retrieve detailed statistics and reports for mailbox restores to troubleshoot issues.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned. |
| Tenant Filter | Target tenant domain or 'AllTenants' for multi-tenant operations. |
| Additional Fields | Optional additional parameters to filter the mailbox restores, including Identity, Include Report, and Statistics. |
Output
JSON
json- The response data from the ListMailboxRestores API call, typically an array of mailbox restore request objects.
Dependencies
- An API key credential for authentication to the CIPP API
Troubleshooting
- Ensure the tenantFilter parameter is correctly set to a valid tenant domain or 'AllTenants'.
- If pagination is enabled, verify pagination parameters are correctly configured to avoid incomplete data.
- Check API credentials and permissions to ensure access to mailbox restore data.
- Review error messages for specific API response codes indicating issues such as rate limiting or invalid parameters.
Links
- ListMailboxRestores API Documentation - Official API documentation for the ListMailboxRestores endpoint in the CIPP platform.