Endpoints for managing connectors (devices) — listing, creating, configuring backup jobs, access control, retention, and lifecycle management.
List devices
Returns all devices (connectors) belonging to the specified account. Each device represents a connection to a cloud service such as Microsoft 365, Google Workspace, Azure AD, Dynamics 365, Power BI, Zendesk, or Salesforce.
By default, devices that have been scheduled for deletion are excluded from the response.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
query Parameters
allInclude devices scheduled for deletion. Default 0.
List devices › Responses
Create device
Creates a new device (connector) under the specified account. A device represents a connection to a cloud service for backup purposes.
See Connector Types for the supported type values.
The Salesforce connector type string is sforce, while the product property
key uses salesforce.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Create device › Responses
success
Update device
Updates the configuration of an existing device (connector). Use this to modify the device name, cloud service credentials, or other connection settings.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Update device › Responses
success
Delete device
Schedules a device for deletion. The device is not removed immediately — it enters a pending-deletion state and can be restored using the Revive device endpoint before the deletion is finalized.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Delete device › Responses
success
Revive device
Restores a device that has been scheduled for deletion. After a DELETE request marks a device for removal, this endpoint cancels the pending deletion and returns the device to active status.
This endpoint is only effective while the device is in the pending-deletion state. Once deletion has been finalized, the device cannot be recovered.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Revive device › Responses
success
Get device status
Returns the current operational status of the specified device.
An empty <devstatus/> response is normal — it indicates no active backup
operations at this time.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Get device status › Responses
Get device health
Returns the health status of the specified device. Devices report health as a
simple string value (e.g. healthy).
Even unconfigured devices report a "healthy" status. Use the reason query
parameter to get additional context about why a device is in its current
health state.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
query Parameters
reasonIf "true", also returns health reason alongside health string.
Get device health › Responses
List device attributes
Returns all attributes for the specified device. Attributes are key-value metadata that control device behavior and store configuration.
Common attributes include backup_config (JSON), backup_interval (ISO 8601
duration), disable_auto_backup, and bs_do_not_import.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
List device attributes › Responses
Get device attribute
Returns the value of a single named attribute on the specified device.
Common device attributes include:
backup_config— JSON object with connector-specific backup configurationbackup_interval— ISO 8601 duration between automatic backupsdisable_auto_backup— flag to suppress scheduled backupsbs_do_not_import— flag to prevent automatic data import
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
attributeNameGet device attribute › Responses
success
Set device attribute
Creates or updates a single named attribute on the specified device.
Common device attributes include:
backup_config— JSON object with connector-specific backup configurationbackup_interval— ISO 8601 duration between automatic backups (e.g.PT4H)disable_auto_backup— flag to suppress scheduled backupsbs_do_not_import— flag to prevent automatic data import
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
attributeNameSet device attribute › Responses
success
Delete device attribute
Removes a single named attribute from the specified device. The defined device
attributes are backup_config, backup_interval, disable_auto_backup, and
bs_do_not_import.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
attributeNameDelete device attribute › Responses
success
List device jobs
Returns backup and restore jobs for the specified device. By default, the response includes jobs from a window of ±7 days relative to the current time.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
List device jobs › Responses
Update device jobs
Queries and filters jobs for the specified device. The request body specifies the filter criteria, and the response contains matching jobs. By default, the job window is ±7 days from the current time.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Update device jobs › Responses
Create device job
Creates a new backup or restore job for the specified device. Jobs represent individual backup or restore operations that are executed by the connector.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Create device job › Responses
success
Get device job
Returns details for a single backup or restore job on the specified device.
The response for a single job includes a <commands> element with the
operations that were or will be executed as part of the job.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
jobIdGet device job › Responses
Get device access list
Returns the access control list for the specified device. The access list determines which users or tokens have permission to interact with this device and its backup data.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Get device access list › Responses
Update device access list
Replaces the access control list for the specified device. The access list determines which users or tokens have permission to interact with this device and its backup data.
path Parameters
accountId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
deviceId[a-z0-9]{6}-[a-z0-9]… · requiredAccount identifier, in the form xxxxxx-xxxxxx-xxxxxx (lowercase letters and digits).
Update device access list › Responses
success