Skip to main content
Tools Reference

Datto BCDR Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Datto BCDR Tools

dattobcdr_ · 18 tools · Free 17 · Pro 1 Backup and disaster-recovery appliances, Direct-to-Cloud assets and their agents. The credential is the Partner Portal public and secret key pair sent as HTTP Basic against a fixed host. Paging is _page and _perPage with a leading underscore: plain page and perPage are ignored silently and return an unpaginated result, which reads as broken paging rather than as an error. Page size stops at 100, and the device alert read is pinned there regardless, so that tool exposes no page-size argument. Two identifier spaces must not be mixed - appliances are keyed by serial number, Direct-to-Cloud assets and agents by UUID. The connector is reads plus a single write, a bandwidth setting that is reversible. The two screenshot-verification reads return a ten-minute link to the image rather than bytes. The vendor's budget of 10,000 calls an hour is per organization and is shared with Datto SaaS Protection.

All connector tools · Datto BCDR setup guide

Datto BCDR tool groups

Devices

ToolPlanAccessSummary
dattobcdr_get_deviceFreeRead-onlyGet one BCDR appliance by serial number, with its full detail: model, service plan and expiry, local and offsite storage usage, last-seen time, and protected-asset and alert rollups.
dattobcdr_list_devicesFreeRead-onlyList the partner's BCDR appliances (SIRIS, ALTO, NAS) — the ENTRY POINT for this connector.

[Datto BCDR] Get one BCDR appliance by serial number, with its full detail: model, service plan and expiry, local and offsite storage usage, last-seen time, and protected-asset and alert rollups. Requires a serialNumber from dattobcdr_list_devices. Use this when you already know which appliance you care about; use dattobcdr_list_devices to discover serial numbers. Unpaginated — returns a single device object.

ParamTypeRequiredDefaultDescription
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices. Not a UUID — Direct-to-Cloud assets use UUIDs instead.

[Datto BCDR] List the partner's BCDR appliances (SIRIS, ALTO, NAS) — the ENTRY POINT for this connector. Each device carries its serialNumber, name, model, service plan and expiration, local and offsite storage usage, and a rollup of protected-asset and alert counts. The returned serialNumber is the identifier required by dattobcdr_get_device, dattobcdr_list_device_assets, dattobcdr_list_device_agents, dattobcdr_list_device_shares, dattobcdr_get_device_volume_asset, dattobcdr_list_device_alerts, dattobcdr_list_device_vm_restores and dattobcdr_get_asset_latest_screenshot. Note appliances are keyed by SERIAL NUMBER while Direct-to-Cloud assets and agents are keyed by UUID — they are different identifier spaces and are not interchangeable. Hidden devices and child-reseller devices are EXCLUDED unless the corresponding flag is set. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.
showChildResellerDevicesbooleannonullSet true to include devices belonging to child resellers. Omit or false to exclude them (Datto's default).
showHiddenDevicesbooleannonullSet true to include devices hidden in the Datto portal. Omit or false to exclude them (Datto's default).

Agents

ToolPlanAccessSummary
dattobcdr_list_agentsFreeRead-onlyList every client (organization) and its protected agents across ALL of the partner's appliances at once — the partner-wide rollup.
dattobcdr_list_device_agentsFreeRead-onlyList the protected AGENTS on one appliance — backed-up machines only, excluding file shares.

[Datto BCDR] List every client (organization) and its protected agents across ALL of the partner's appliances at once — the partner-wide rollup. Use this to answer questions that span appliances, such as which clients have agents that have not checked in. To scope to a single appliance instead, use dattobcdr_list_device_agents with a serial number from dattobcdr_list_devices. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.

[Datto BCDR] List the protected AGENTS on one appliance — backed-up machines only, excluding file shares. Each agent carries its volume name, hostname, operating system, protected volumes, latest and last-successful backup times, local and offsite snapshot counts, and its most recent screenshot-verification result. Requires a serialNumber from dattobcdr_list_devices. For shares use dattobcdr_list_device_shares; for both together use dattobcdr_list_device_assets. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices.

Assets

ToolPlanAccessSummary
dattobcdr_get_device_volume_assetFreeRead-onlyGet ONE protected asset (agent or share) on an appliance, addressed by its volume name.
dattobcdr_list_device_assetsFreeRead-onlyList ALL protected assets on one appliance — agents (backed-up machines) and shares (file shares) together, in one call.
dattobcdr_list_device_sharesFreeRead-onlyList the protected SHARES on one appliance — NAS and SIRIS file shares only, excluding backed-up machines.

[Datto BCDR] Get ONE protected asset (agent or share) on an appliance, addressed by its volume name. Returns the same detail as the list reads for a single asset: protected size, latest and last-successful backup times, snapshot counts and verification results. Requires a serialNumber from dattobcdr_list_devices and a volume name from dattobcdr_list_device_assets, dattobcdr_list_device_agents or dattobcdr_list_device_shares. Unpaginated — returns a single asset object.

ParamTypeRequiredDefaultDescription
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices.
volumeNamestringyesThe asset's volume name, from dattobcdr_list_device_assets, dattobcdr_list_device_agents or dattobcdr_list_device_shares.

[Datto BCDR] List ALL protected assets on one appliance — agents (backed-up machines) and shares (file shares) together, in one call. Each asset carries its volume name, type, protected size, latest and last-successful backup times, local and offsite snapshot counts, and backup-verification results where applicable. The returned volume name is the identifier required by dattobcdr_get_device_volume_asset and dattobcdr_get_asset_latest_screenshot. Requires a serialNumber from dattobcdr_list_devices. Use dattobcdr_list_device_agents or dattobcdr_list_device_shares when you want only one kind. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices.

[Datto BCDR] List the protected SHARES on one appliance — NAS and SIRIS file shares only, excluding backed-up machines. Each share carries its volume name, protected size, latest and last-successful backup times, and local and offsite snapshot counts. Requires a serialNumber from dattobcdr_list_devices. For agents use dattobcdr_list_device_agents; for both together use dattobcdr_list_device_assets. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices.

Screenshots

ToolPlanAccessSummary
dattobcdr_get_asset_latest_screenshotFreeRead-onlyGet the most recent screenshot-verification image for a protected volume on an appliance — the screen capture Datto takes when it boots a backup to prove the backup is restorable.
dattobcdr_get_dtc_asset_latest_screenshotFreeRead-onlyGet the most recent screenshot-verification image for a Direct-to-Cloud asset — the screen capture Datto takes when it boots a cloud backup to prove it is restorable.

[Datto BCDR] Get the most recent screenshot-verification image for a protected volume on an appliance — the screen capture Datto takes when it boots a backup to prove the backup is restorable. Returns a short-lived read-only download URL (valid about ten minutes) plus the image's content type, size in bytes and expiry time; the image itself is NOT inlined in the response, so fetch the URL to view it. Use this to confirm a backup that reports success actually boots, or to see the error screen behind a screenshot-verification failure reported by dattobcdr_list_device_alerts. Requires a serialNumber from dattobcdr_list_devices and a volume name from dattobcdr_list_device_assets or dattobcdr_list_device_agents. Fails with a clear error rather than returning a dead link if file storage is unavailable.

ParamTypeRequiredDefaultDescription
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices.
volumeNamestringyesThe protected volume's name, from dattobcdr_list_device_assets or dattobcdr_list_device_agents.

[Datto BCDR] Get the most recent screenshot-verification image for a Direct-to-Cloud asset — the screen capture Datto takes when it boots a cloud backup to prove it is restorable. Returns a short-lived read-only download URL (valid about ten minutes) plus the image's content type, size in bytes and expiry time; the image itself is NOT inlined in the response, so fetch the URL to view it. This is the Direct-to-Cloud counterpart of dattobcdr_get_asset_latest_screenshot, and it uses different identifiers: a client id and an asset UUID from dattobcdr_list_client_dtc_assets, NOT an appliance serial number and volume name. Fails with a clear error rather than returning a dead link if file storage is unavailable.

ParamTypeRequiredDefaultDescription
assetUuidstringyesThe Direct-to-Cloud asset's UUID, from dattobcdr_list_client_dtc_assets. A UUID, not an appliance serial number.
clientIdstringyesThe client (organization) id, from dattobcdr_list_dtc_assets or dattobcdr_list_client_dtc_assets.

Alerts

ToolPlanAccessSummary
dattobcdr_list_device_alertsFreeRead-onlyList the alerts raised by one appliance — backup failures, screenshot-verification failures, storage pressure, offsite-sync problems and connectivity loss.

[Datto BCDR] List the alerts raised by one appliance — backup failures, screenshot-verification failures, storage pressure, offsite-sync problems and connectivity loss. Each alert carries its type, severity, the asset it concerns and when it was raised. Requires a serialNumber from dattobcdr_list_devices. NOTE: this endpoint returns a FIXED 100 alerts per page — Datto ignores any other page size — so there is deliberately no page-size argument here; page through with the page argument instead. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1). Each page holds a fixed 100 alerts.
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices.

Restores

ToolPlanAccessSummary
dattobcdr_list_device_vm_restoresFreeRead-onlyList the VM restore records on one appliance — virtualizations that already exist, with the asset each one restores, the snapshot it was built from, its type (local or offsite virtualization) and its…

[Datto BCDR] List the VM restore records on one appliance — virtualizations that already exist, with the asset each one restores, the snapshot it was built from, its type (local or offsite virtualization) and its current state. This is a READ: it reports restores that have already been created and CANNOT start, stop or modify one. The Datto v1 API exposes no restore-trigger endpoint, so starting a restore remains a Datto portal or appliance action. Useful for spotting virtualizations left running, which consume appliance resources. Requires a serialNumber from dattobcdr_list_devices. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.
serialNumberstringyesThe appliance's serial number, from dattobcdr_list_devices.

Reporting

ToolPlanAccessSummary
dattobcdr_get_activity_logFreeRead-onlyRead the partner's activity log, newest first — who did what, to which device or asset, and when.

[Datto BCDR] Read the partner's activity log, newest first — who did what, to which device or asset, and when. Use it to answer audit questions such as which administrator changed a backup schedule or started a virtualization. The time window is expressed as a COUNT plus a UNIT, not as timestamps: since=7 with sinceUnits=days means the last seven days. Filters combine: clientName narrows to one organization, user narrows to one actor, targetType narrows to a kind of object, and target names specific objects as targetType:targetId entries. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
clientNamestringnonullFilter to one client (organization) by name, as Datto spells it.
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.
sinceintegernonullHow far back to look, as a COUNT of sinceUnits — e.g. 7 with sinceUnits=days. Datto's default is 1.
sinceUnitsstringnonullThe unit for since: days, hours or minutes. Datto's default is days.
targetarraynonullRestrict to specific objects. Each entry is targetType:targetId, e.g. device:ABC123. Repeat for multiple objects.
targetTypestringnonullRestrict to a kind of object (e.g. device, agent, share) without naming specific ones.
userstringnonullFilter to one actor by Datto username.

Direct-to-Cloud

ToolPlanAccessSummary
dattobcdr_get_dtc_assetFreeRead-onlyGet one Direct-to-Cloud asset in full: hostname, operating system, protected volumes, agent version, last check-in and backup times, retention and cloud storage consumption.
dattobcdr_get_dtc_storage_poolFreeRead-onlyRead Direct-to-Cloud cloud storage consumption broken down by storage pool, with each pool's name, capacity and used space.
dattobcdr_list_client_dtc_assetsFreeRead-onlyList the Direct-to-Cloud assets belonging to ONE client (organization), with each asset's UUID, hostname, operating system, protected size and backup state.
dattobcdr_list_dtc_assetsFreeRead-onlyList every Direct-to-Cloud asset across ALL of the partner's clients — machines that back up straight to the Datto cloud with no on-site appliance.
dattobcdr_list_dtc_rmm_templatesFreeRead-onlyList the RMM deployment templates available for rolling out Direct-to-Cloud agents — the prepared configurations used to install the DTC agent through an RMM rather than by hand.
dattobcdr_update_dtc_agent_bandwidthProWriteUpdate the bandwidth throttle settings for one Direct-to-Cloud agent — how much network capacity that agent may use when sending backups to the Datto cloud.

[Datto BCDR] Get one Direct-to-Cloud asset in full: hostname, operating system, protected volumes, agent version, last check-in and backup times, retention and cloud storage consumption. Requires a client id and an asset UUID from dattobcdr_list_client_dtc_assets. Unpaginated — returns a single asset object.

ParamTypeRequiredDefaultDescription
assetUuidstringyesThe Direct-to-Cloud asset's UUID, from dattobcdr_list_client_dtc_assets.
clientIdstringyesThe client (organization) id, from dattobcdr_list_dtc_assets.

[Datto BCDR] Read Direct-to-Cloud cloud storage consumption broken down by storage pool, with each pool's name, capacity and used space. Use it to spot a pool approaching its limit before backups start failing for capacity. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.

[Datto BCDR] List the Direct-to-Cloud assets belonging to ONE client (organization), with each asset's UUID, hostname, operating system, protected size and backup state. The returned asset UUID is required by dattobcdr_get_dtc_asset and dattobcdr_get_dtc_asset_latest_screenshot. Requires a client id from dattobcdr_list_dtc_assets. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
clientIdstringyesThe client (organization) id, from dattobcdr_list_dtc_assets.
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.

[Datto BCDR] List every Direct-to-Cloud asset across ALL of the partner's clients — machines that back up straight to the Datto cloud with no on-site appliance. The partner-wide rollup, and the place to discover client ids and asset UUIDs. To scope to one client instead, use dattobcdr_list_client_dtc_assets. Note DTC assets are keyed by UUID, while appliances and their volumes are keyed by serial number and volume name — the two identifier spaces are not interchangeable. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.

[Datto BCDR] List the RMM deployment templates available for rolling out Direct-to-Cloud agents — the prepared configurations used to install the DTC agent through an RMM rather than by hand. Read only: this reports the templates that exist and cannot create, edit or deploy one. Paginated: the response wraps items alongside a pagination object carrying totalPages.

ParamTypeRequiredDefaultDescription
pageintegerno1Page number, 1-based (default 1).
perPageintegerno100Results per page (1-100, default 100). Larger values are clamped to 100.

[Datto BCDR] Update the bandwidth throttle settings for one Direct-to-Cloud agent — how much network capacity that agent may use when sending backups to the Datto cloud. NOT DESTRUCTIVE: this writes a reversible configuration value and destroys no data, deletes no asset and cancels no backup; re-running the tool with the previous values restores the prior state exactly. Do still check the value before applying it, because setting the limit too low slows that customer's backups until someone changes it back, and the effect is easy to miss for days. Requires an agent UUID from dattobcdr_list_client_dtc_assets. The request body is passed through to Datto verbatim, and its exact field names are reconstructed from Datto's public API description rather than confirmed against a live tenant — so read the current settings with dattobcdr_get_dtc_asset first and mirror the shape you see there. Datto returns the updated settings.

ParamTypeRequiredDefaultDescription
agentUuidstringyesThe Direct-to-Cloud AGENT's UUID, from dattobcdr_list_client_dtc_assets.
settingsJsonstringyesThe bandwidth settings to apply, as a JSON object. Passed to Datto verbatim — mirror the shape returned by dattobcdr_get_dtc_asset rather than guessing field names.