Operations at mailboxRestore/

This page describes the service operations at this endpoint.

URI	Method	Description
mailboxRestore/closeDatabase/{databaseId}	POST	Closes the database.
mailboxRestore/config	GET	Sets AutoUpdate configuration.
mailboxRestore/config	POST	Sets AutoUpdate configuration.
mailboxRestore/continueRestore	POST	Continues execution of mail restore job. It is only used for cases when error handling mode was set to Notify and there was an error during job execution.
mailboxRestore/copyRequiredDlls	POST	Copies specified Exchange libraries from a local or network path to the special location.
mailboxRestore/createRestoreSession/{displayName}	POST	Creates a new restore session.
mailboxRestore/downloadRequiredDlls	POST	Downloads Exchange libraries to client.
mailboxRestore/folderItems/paged?max={max}&page={page}	POST	Returns a collection of folders items inside of a folder, on the specified page, in sorted and filtered state.
mailboxRestore/folders	POST	Returns a collection of folders inside of the open database.
mailboxRestore/getExchangeVersion	POST	Determines version of Exchange for the specified database or for the specified recovery point Id.
mailboxRestore/getGlobalAddressBook?session={restoreSessionId}&profile={profileName}	GET	Returns a collection of entries in the global address book.
mailboxRestore/getMapiProfiles	POST	Returns a collection of MAPI profiles.
mailboxRestore/getRequiredDllsInfo	POST	Retrieves information about required Exchange libraries for the given version of Exchange from the specified server, the specified directory or UNC path.
mailboxRestore/getRequiredExchangeDlls	POST	Returns a collection of required Exchange dlls (ese.dll, exchmem.dll etc) for the specified version of Exchange.
mailboxRestore/getRestoreSessions	GET	Returns a collection of currently existing restore sessions.
mailboxRestore/mailboxes/{databaseId}	GET	Returns a collections of mailboxes inside of the open database.
mailboxRestore/openDatabase	POST	Opens an Exchange database (returns ID of a new background job).
mailboxRestore/openedDatabases	GET	Returns a collection of open databases.
mailboxRestore/removeRestoreSession	POST	Removes a restore session. Note: this may cause failure of mail restore jobs which are using the specified session.
mailboxRestore/search/{id}/allResults	GET	Returns a collection of all found by search job items. Note: some fields like folder items' from / to / subject / etc may be empty for saving memory and better performance.
mailboxRestore/search/{id}/isRunning	GET	Verifies whether the specified search job is running.
mailboxRestore/searchResults/paged?max={max}&page={page}	POST	Returns a collection of found by search job items, on the specified page, in sorted and filtered state.
mailboxRestore/startRestore	POST	Starts a new mail restore job and returns its identifier.
mailboxRestore/startSearch	POST	Starts a new search job and returns its identifier.
mailboxRestore/verifyDatabaseFilePath/{databaseFilePath}	POST	Verifies path of Exchange database file and throws various exceptions if the path is invalid. Note: this check is mandatory; invalid database file cannot be opened.
mailboxRestore/verifyDatabaseLogsPath/{logsPath}	POST	Verifies path of Exchange database logs files. Note: this check is optional; if the logs path is invalid, the database still can be opened.
mailboxRestore/verifyDatabaseSystemPath/{systemPath}	POST	Verifies path of Exchange database system files. Note: this check is optional; if the system path is invalid, the database still can be opened.
mailboxRestore/verifyExchangeDlls	POST	Verifies presence of required Exchange dlls (ese.dll, exchmem.dll etc) for the specified version of Exchange.