Actions75
- EndpointAutopilot Actions
- TenantAdministrationAlerts Actions
- EndpointMEM Actions
- TenantGDAP Actions
- TenantAdministrationApplicationApproval Actions
- TenantAdministration Actions
- CIPPSetup Actions
- Security Actions
- IdentityAdministrationDevices Actions
- CIPPExtensions Actions
- EmailExchangeTools Actions
EmailExchangeTools → ExecMailboxRestore
AI-generatedOverview
This node performs mailbox restore operations within the EmailExchangeTools resource of the CIPP API. It allows users to initiate mailbox restore requests by specifying various parameters such as tenant filter, source and target mailboxes, limits on bad and large items, folder inclusion/exclusion, and other mailbox restore options. This node is useful for administrators managing Exchange mailboxes who need to restore mailbox data from backups or previous states.
Use Case Examples
- Restore a mailbox for a specific tenant by specifying the source mailbox, target mailbox, and other restore options.
- Perform a mailbox restore operation across all tenants by setting the tenant filter to 'AllTenants' and configuring the restore parameters accordingly.
Properties
| Name | Meaning |
|---|---|
| Tenant Filter | Target tenant domain or 'AllTenants' for multi-tenant operations. |
| Action | The action to perform during the mailbox restore. |
| Identity | The identity of the mailbox or restore request. |
| Request Name | The name of the restore request. |
| Source Mailbox | The source mailbox from which data will be restored. |
| Target Mailbox | The target mailbox to which data will be restored. |
| Bad Item Limit | The limit on bad items allowed during restore. |
| Large Item Limit | The limit on large items allowed during restore. |
| Accept Large Data Loss | Flag to accept large data loss during restore. |
| Associated Messages Copy Option | Option for copying associated messages. |
| Exclude Folders | Folders to exclude from the restore operation. |
| Include Folders | Folders to include in the restore operation. |
| Batch Name | The batch name for the restore operation. |
| Completed Request Age Limit | Age limit for completed requests. |
| Conflict Resolution Option | Option for resolving conflicts during restore. |
| Source Root Folder | The root folder in the source mailbox. |
| Target Root Folder | The root folder in the target mailbox. |
| Target Type | The type of the target mailbox. |
| Exclude Dumpster | Flag to exclude dumpster data during restore. |
| Source Is Archive | Flag indicating if the source mailbox is an archive. |
| Target Is Archive | Flag indicating if the target mailbox is an archive. |
Output
JSON
json- The JSON response from the mailbox restore API call, containing details of the restore operation result.
Dependencies
- An API key credential for authenticating with the CIPP API
Troubleshooting
- Ensure the tenant filter is correctly specified and the tenant domain exists.
- Verify that the source and target mailboxes are valid and accessible.
- Check API permissions and authentication credentials for the CIPP API.
- If the operation fails, review the debug output (if enabled) for request details and error messages.