API calls

For each of the following calls, you will find the signature of the call, the data structure, and the result.

• AddAdministrativeRestoreJob—AddAdministrativeRestoreJob is used to restore files to the same device or from one device to another. The equivalent options in the dashboard are on the Restore tab for a device.
• CancelDashboardDevice—CancelDashboardDevice is used to delete a device from OpenText Core Endpoint Backup. All of the protected data will be deleted from the vault. You will not be able to restore any data. The device will not longer be protected. You might use this feature when you want to remove the data from the vault or no longer need the backup. It allows you to stop using the license. This action is not reversible. Once the device is deleted, the data that was backed up cannot be accessed. The equivalent option in the dashboard is the Delete device button on the Manage device tab for a device.
• DeleteDataFromDashboardDevice—DeleteDataFromDashboardDevice is used to delete all of the protected data from the device. Unprotected data on the device will not be deleted. The protected data will not be deleted from the vault, only from the device. You might use this feature if a laptop is lost or stolen, and there is concern that someone malicious will access the laptop and the files on it. This option also resets the license so you can reuse it again later, on the same or a different device. The equivalent option in the dashboard is the Delete data from device button on the Manage device tab for a device. (After deleting data from a device, you will have to generate a new license by using Reset device on the Manage device tab for the device.)
• EditDashboardDeviceInfo—EditDashboardDeviceInfo is used to modify the device name, custom fields, policy set, and storage quota. You should limit the number of edited devices in a single call to 1000. Requests larger than 1000 should use successive calls to the web service. The equivalent option in the dashboard is the Edit device button on the Device details tab for a device.
• GetDashboardDeviceInfo—GetDashboardDeviceInfo is used to get the details for one or more devices in the system. Usually it is used in other calls, but you can also use it to inspect the state of a current device. It has a flexible input format to allow devices to be identified in different ways and will return a list of matching devices. You should limit the number of devices requested in a single call to 1000. Requests larger than 1000 should use successive calls to the web service. The equivalent option in the dashboard is the details displayed on the Device details tab for a device.
• GetDeviceList—GetDeviceList is used to return a list of devices. The list will be limited to only those devices that the specified user has access to, the devices under the specified entity (partner, company, user ID, or user), and the devices filtered by the specified string. GetDeviceList should be used to navigate through manageable devices. Do not use it to generate reports. GetDeviceList is limited to 100 devices. The equivalent option in the dashboard is the list displayed on the Devices page. You can get a complete list of all devices by clicking Download list on that same page.
• ProvisionEntities—ProvisionEntities is used to add a device. One device is added for each input item. If the specified user, user group, or company does not exist, it will be added. The equivalent option in the dashboard is the Add device button on the Company or Devices page.
• ProvisionUsers—ProvisionUsers is used to add a user. One user is added for each input item. If the specified user group or company does not exist, it will be created. The equivalent option in the dashboard is the Add user button on the Company or Users page.
• ReactivateSuspendedDashboardDevice—ReactivateSuspendedDashboardDevice is used to reactivate a suspended device. The device will begin backing up again. The equivalent option in the dashboard is the Reactivate device button on the Manage device tab for a device.
• SendActivationEmail—SendActivationEmail is used to send an email to the user who owns the device. The email message contains the details for activating the device. This is the same email when a device is initially created and contains the details seen when viewing the Help activating device link from the device details in the dashboard. The email is sent using the SMTP settings configured for the vault. The equivalent option in the dashboard is the Send link on the To install the data protection agent pop-up shown after clicking the Help activating device link on the Device details tab for a device.
• SuspendDashboardDevice—SuspendDashboardDevice is used to suspend a device that you want to stop protecting. A suspended device will no longer back up data, but the data that is already backed up is preserved. The equivalent option in the dashboard is the Suspend device button on the Manage device tab for a device. After suspension, you can reactivate the device, if desired.
• UpdateDeviceLegalHoldState—UpdateDeviceLegalHoldState is used to disable and re-enable the retention and erase options. When disabled, the legal hold keeps data from being deleted from the vault, and it keeps the device from being deleted. You might use this feature when you are legally required to preserve data, for example because of a lawsuit or a user investigation. The data can be made available upon request, and it prevents someone from trying to delete files or entire backups. You can re-enable the device when the legal hold is no longer needed. The equivalent options in the dashboard are the Put on legal hold and Remove from legal hold buttons on the Manage device tab for a device.