Datto BCDR
App · 21 actions
Watch and report on Datto BCDR backups: devices, agents and shares, alerts, screenshot verification, Direct-to-Cloud assets, the activity log and SaaS Protection seats.
Actions
| Action | What it does |
|---|---|
| Change SaaS seats | Protect, pause or stop protecting up to 100 SaaS Protection seats of one type at once. |
| Get asset | Get one agent or share on a BCDR device by its volume, with its last backup, off-site copy, screenshot verification and recent backups. |
| Get device | Get one BCDR device by its serial number: its client, model, service plan, warranty, storage used and free, last check-in and counts of agents, shares and alerts. |
| Get Direct-to-Cloud asset | Get one Direct-to-Cloud asset of a client. |
| Get Direct-to-Cloud storage pool | Get how much of your Direct-to-Cloud storage pool is used. |
| Get SaaS backup stats | Get a SaaS Protection customer's detailed backup statistics: users, licenses, storage and the last seven days of backups. |
| Get screenshot results | Get the latest screenshot verification of every agent on a BCDR device: whether it passed, when it ran, the link to the screenshot, and the agent's last backup and off-site copy. |
| List activity log | List what people did in the Datto Partner Portal and on devices, newest first, filtered by time, device, client or user. |
| List device agents | List the machines (agents) a BCDR device backs up, with each one's operating system, agent version, last backup, last off-site copy and latest screenshot verification. |
| List device alerts | List the open alerts on a BCDR device, with when each was raised. |
| List device assets | List everything a BCDR device protects, agents and shares, with each one's last backup, last off-site copy and latest screenshot verification. |
| List device shares | List the file shares (NAS, iSCSI and external shares) a BCDR device backs up, with each one's last backup and off-site copy. |
| List devices | List the BCDR devices (SIRIS, ALTO, NAS and cloud devices) the API key can see, with each one's client, model, storage, last check-in and how many agents, shares and alerts it has. |
| List Direct-to-Cloud assets | List the machines backed up straight to the Datto cloud (Direct-to-Cloud), for every client or for one. |
| List Direct-to-Cloud RMM templates | List the RMM templates that install Direct-to-Cloud agents, for every client or for one. |
| List Endpoint Backup agents | List the Endpoint Backup for PCs clients and the agents under each one. |
| List SaaS applications | Get a SaaS Protection customer's backup report per application (mail, OneDrive, SharePoint and so on): storage used and recent backup history. |
| List SaaS domains | List the Microsoft 365 and Google Workspace domains SaaS Protection backs up, with each customer's id, subscription id and seats used. |
| List SaaS seats | List a SaaS Protection customer's seats (users, shared mailboxes, sites, teams and shared drives) and whether each is protected, paused or unprotected. |
| List VM restores | List the virtual machines running on a BCDR device from its backups: restores and virtualizations in progress. |
| Set Direct-to-Cloud agent bandwidth | Set how much bandwidth a Direct-to-Cloud agent may use for backups, normally and when throttled, and whether it pauses on a metered connection. |
Change SaaS seats
Protect, pause or stop protecting up to 100 SaaS Protection seats of one type at once. Protecting a seat adds it to the customer's bill. Works with Seat Management 2.0.
Inputs
- SaaS Protection customer
saas_customer_idtextRequired - The SaaS Protection customer. Pick one, or give its id from 'List SaaS domains'.
- Subscription
external_subscription_idtextRequired - The customer's Microsoft 365 or Google Workspace subscription. Pick one, or give its id from 'List SaaS domains'.
- Seat type
seat_typetextRequired - What kind of seats these are.One of:
User(User (mailbox or Google user)),SharedMailbox(Shared mailbox (Microsoft 365)),Site(SharePoint site (Microsoft 365)),TeamSite(Team site (Microsoft 365)),Team(Team (Microsoft 365)),SharedDrive(Shared drive (Google Workspace)). - Change
seat_actiontextRequired - What to do to the seats.One of:
License(Protect (license the seat)),Pause(Pause backups),Unlicense(Stop protecting (unlicense the seat)). - Seats
remote_idslistRequired - The seats to change, at most 100. Pick them, or give their 'remoteId' from 'List SaaS seats'.
Outputs
external_subscription_idtext- The subscription changed
requested_countnumber- How many seats were sent
resultslist- Datto's answer per seat, as it gives it
saas_customer_idnumber- The SaaS Protection customer's id
seat_actiontext- License, Pause or Unlicense
seat_typetext- The seat type sent
Example output
{
"external_subscription_id": "Classic:Office365:654321",
"requested_count": 1,
"results": [
{
"action": "License",
"id": "ab23f1c4-bdf2-4a34-9a1d-1234567890ab",
"status": "success"
}
],
"saas_customer_id": 123456,
"seat_action": "License",
"seat_type": "User"
}Get asset
Get one agent or share on a BCDR device by its volume, with its last backup, off-site copy, screenshot verification and recent backups.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
- Asset
volume_nametextRequired - The agent or share. Pick one, or give its 'volume' from 'List device assets'.
Outputs
assetobject- The asset
assetslist- Every asset on that volume; usually just the one
serial_numbertext- The device's serial number
Example output
{
"asset": {
"agentVersion": "3.1.4",
"backups": [],
"fqdn": "fs01.acme.local",
"isArchived": false,
"isPaused": false,
"lastScreenshotAttempt": 1763292600,
"lastScreenshotAttemptStatus": false,
"lastScreenshotUrl": "https://device.dattobackup.com/screenshots/A1B2C3D4E5F6/fs01.jpg",
"lastSnapshot": 1763290800,
"latestOffsite": 1763283600,
"localIp": "10.0.0.31",
"localSnapshots": 148,
"name": "FS01",
"os": "Windows Server 2022 Standard",
"protectedVolumeNames": [
"C:",
"D:"
],
"protectedVolumesCount": 2,
"type": "agent",
"unprotectedVolumeNames": [],
"unprotectedVolumesCount": 0,
"volume": "3f7c9a20d1e64b0a9f3b7e2c5d8a1b44"
},
"assets": [
{
"agentVersion": "3.1.4",
"backups": [],
"fqdn": "fs01.acme.local",
"isArchived": false,
"isPaused": false,
"lastScreenshotAttempt": 1763292600,
"lastScreenshotAttemptStatus": false,
"lastScreenshotUrl": "https://device.dattobackup.com/screenshots/A1B2C3D4E5F6/fs01.jpg",
"lastSnapshot": 1763290800,
"latestOffsite": 1763283600,
"localIp": "10.0.0.31",
"localSnapshots": 148,
"name": "FS01",
"os": "Windows Server 2022 Standard",
"protectedVolumeNames": [
"C:",
"D:"
],
"protectedVolumesCount": 2,
"type": "agent",
"unprotectedVolumeNames": [],
"unprotectedVolumesCount": 0,
"volume": "3f7c9a20d1e64b0a9f3b7e2c5d8a1b44"
}
],
"serial_number": "A1B2C3D4E5F6"
}Get device
Get one BCDR device by its serial number: its client, model, service plan, warranty, storage used and free, last check-in and counts of agents, shares and alerts.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
Outputs
deviceobject- The device
Example output
{
"device": {
"activeTickets": 0,
"agentCount": 2,
"alertCount": 1,
"clientCompanyName": "Acme Corp",
"hidden": false,
"internalIP": "10.0.0.20",
"lastSeenDate": "2026-11-16T09:41:02+00:00",
"localStorageAvailable": {
"size": 5.2,
"units": "TB"
},
"localStorageUsed": {
"size": 2.1,
"units": "TB"
},
"model": "S5-2",
"name": "ACME-SIRIS",
"offsiteStorageUsed": {
"size": 1.9,
"units": "TB"
},
"registrationDate": "2024-02-14T10:12:00+00:00",
"remoteWebUrl": "https://device.dattobackup.com/sirisReporting/remoteWeb/A1B2C3D4E5F6",
"resellerCompanyName": "Contoso IT",
"serialNumber": "A1B2C3D4E5F6",
"servicePeriod": "2027-02-14T00:00:00+00:00",
"servicePlan": "Infinite Cloud Retention",
"shareCount": 1,
"uptime": 1296000,
"warrantyExpire": "2027-02-14T00:00:00+00:00"
}
}Get Direct-to-Cloud asset
Get one Direct-to-Cloud asset of a client.
Inputs
- Client ID
client_idnumberRequired - The client's number, as 'List Direct-to-Cloud assets' shows it.At least 1.
- Asset UUID
asset_uuidtextRequired - The asset's UUID, from 'List Direct-to-Cloud assets'.
Outputs
assetobject- The asset, as Datto gives it
Example output
{
"asset": {
"assetUuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "LAPTOP-JO"
}
}Get Direct-to-Cloud storage pool
Get how much of your Direct-to-Cloud storage pool is used.
Inputs
None.
Outputs
storage_poolobject- The storage pool's usage, as Datto gives it
Example output
{
"storage_pool": {
"usedBytes": 1099511627776
}
}Get SaaS backup stats
Get a SaaS Protection customer's detailed backup statistics: users, licenses, storage and the last seven days of backups.
Inputs
- SaaS Protection customer
saas_customer_idtextRequired - The SaaS Protection customer. Pick one, or give its id from 'List SaaS domains'.
Outputs
saas_customer_idnumber- The SaaS Protection customer's id
statsobject- The statistics, as Datto gives them
Example output
{
"saas_customer_id": 123456,
"stats": {
"numberOfStandardLicensesTotal": 50,
"numberOfUsers": 42,
"tenantName": "Acme Corp"
}
}Get screenshot results
Get the latest screenshot verification of every agent on a BCDR device: whether it passed, when it ran, the link to the screenshot, and the agent's last backup and off-site copy. Optionally only the failures.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
- Only failures
only_failurestrue/false - Return only the agents whose latest screenshot failed.
Outputs
countnumber- How many results came back
failed_countnumber- How many agents' latest screenshot failed
passed_countnumber- How many agents' latest screenshot passed
resultslist- One per agent
serial_numbertext- The device's serial number
Example output
{
"count": 1,
"failed_count": 1,
"passed_count": 0,
"results": [
{
"attempted": true,
"attempted_at": "2025-11-16T11:30:00Z",
"is_archived": false,
"is_paused": false,
"last_backup_at": "2025-11-16T11:00:00Z",
"last_offsite_at": "2025-11-16T09:00:00Z",
"name": "FS01",
"passed": false,
"screenshot_url": "https://device.dattobackup.com/screenshots/A1B2C3D4E5F6/fs01.jpg",
"volume": "3f7c9a20d1e64b0a9f3b7e2c5d8a1b44"
}
],
"serial_number": "A1B2C3D4E5F6"
}List activity log
List what people did in the Datto Partner Portal and on devices, newest first, filtered by time, device, client or user.
Inputs
- Since
sincedate and time - Only activity after this time. Datto's default is the last day.
- Device
serial_numbertext - Only activity on this device.
- Client name
client_nametext - Only clients whose name starts with this.
- User
usernametext - Only users whose name starts with this.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
entrieslist- The entries, as Datto gives them
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
Example output
{
"count": 1,
"entries": [
{
"action": "device.agent.pause",
"target": "A1B2C3D4E5F6",
"targetType": "bcdr-device",
"timestamp": "2026-11-16T09:12:00+00:00",
"user": "jo@contoso-it.com"
}
],
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
}
}List device agents
List the machines (agents) a BCDR device backs up, with each one's operating system, agent version, last backup, last off-site copy and latest screenshot verification.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
agentslist- The agents, as Datto gives them
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
serial_numbertext- The device's serial number
Example output
{
"agents": [
{
"agentVersion": "3.1.4",
"backups": [],
"fqdn": "fs01.acme.local",
"isArchived": false,
"isPaused": false,
"lastScreenshotAttempt": 1763292600,
"lastScreenshotAttemptStatus": false,
"lastScreenshotUrl": "https://device.dattobackup.com/screenshots/A1B2C3D4E5F6/fs01.jpg",
"lastSnapshot": 1763290800,
"latestOffsite": 1763283600,
"localIp": "10.0.0.31",
"localSnapshots": 148,
"name": "FS01",
"os": "Windows Server 2022 Standard",
"protectedVolumeNames": [
"C:",
"D:"
],
"protectedVolumesCount": 2,
"type": "agent",
"unprotectedVolumeNames": [],
"unprotectedVolumesCount": 0,
"volume": "3f7c9a20d1e64b0a9f3b7e2c5d8a1b44"
}
],
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"serial_number": "A1B2C3D4E5F6"
}List device alerts
List the open alerts on a BCDR device, with when each was raised.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
alertslist- The open alerts
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
serial_numbertext- The device's serial number
Example output
{
"alerts": [
{
"dateTriggered": "2026-11-16T03:00:12+00:00",
"type": "Backup Failed"
}
],
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"serial_number": "A1B2C3D4E5F6"
}List device assets
List everything a BCDR device protects, agents and shares, with each one's last backup, last off-site copy and latest screenshot verification.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
assetslist- The assets, as Datto gives them
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
serial_numbertext- The device's serial number
Example output
{
"assets": [
{
"agentVersion": "3.1.4",
"backups": [],
"fqdn": "fs01.acme.local",
"isArchived": false,
"isPaused": false,
"lastScreenshotAttempt": 1763292600,
"lastScreenshotAttemptStatus": false,
"lastScreenshotUrl": "https://device.dattobackup.com/screenshots/A1B2C3D4E5F6/fs01.jpg",
"lastSnapshot": 1763290800,
"latestOffsite": 1763283600,
"localIp": "10.0.0.31",
"localSnapshots": 148,
"name": "FS01",
"os": "Windows Server 2022 Standard",
"protectedVolumeNames": [
"C:",
"D:"
],
"protectedVolumesCount": 2,
"type": "agent",
"unprotectedVolumeNames": [],
"unprotectedVolumesCount": 0,
"volume": "3f7c9a20d1e64b0a9f3b7e2c5d8a1b44"
},
{
"agentVersion": "",
"backups": [],
"fqdn": "",
"isArchived": false,
"isPaused": false,
"lastScreenshotAttempt": 0,
"lastScreenshotAttemptStatus": false,
"lastScreenshotUrl": "",
"lastSnapshot": 1763290800,
"latestOffsite": 1763283600,
"localIp": "10.0.0.31",
"localSnapshots": 148,
"name": "Accounting",
"os": "",
"protectedVolumeNames": [],
"protectedVolumesCount": 2,
"type": "share",
"unprotectedVolumeNames": [],
"unprotectedVolumesCount": 0,
"volume": "Accounting"
}
],
"count": 2,
"has_more": false,
"pagination": {
"count": 2,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"serial_number": "A1B2C3D4E5F6"
}List device shares
List the file shares (NAS, iSCSI and external shares) a BCDR device backs up, with each one's last backup and off-site copy.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
serial_numbertext- The device's serial number
shareslist- The shares, as Datto gives them
Example output
{
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"serial_number": "A1B2C3D4E5F6",
"shares": [
{
"agentVersion": "",
"backups": [],
"fqdn": "",
"isArchived": false,
"isPaused": false,
"lastScreenshotAttempt": 0,
"lastScreenshotAttemptStatus": false,
"lastScreenshotUrl": "",
"lastSnapshot": 1763290800,
"latestOffsite": 1763283600,
"localIp": "10.0.0.31",
"localSnapshots": 148,
"name": "Accounting",
"os": "",
"protectedVolumeNames": [],
"protectedVolumesCount": 2,
"type": "share",
"unprotectedVolumeNames": [],
"unprotectedVolumesCount": 0,
"volume": "Accounting"
}
]
}List devices
List the BCDR devices (SIRIS, ALTO, NAS and cloud devices) the API key can see, with each one's client, model, storage, last check-in and how many agents, shares and alerts it has.
Inputs
- Include hidden devices
include_hiddentrue/false - Also list devices hidden in the Partner Portal.
- Include child resellers' devices
include_child_resellertrue/false - Also list the devices of your child resellers.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
countnumber- How many came back on this page
deviceslist- The devices
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
Example output
{
"count": 1,
"devices": [
{
"activeTickets": 0,
"agentCount": 2,
"alertCount": 1,
"clientCompanyName": "Acme Corp",
"hidden": false,
"internalIP": "10.0.0.20",
"lastSeenDate": "2026-11-16T09:41:02+00:00",
"localStorageAvailable": {
"size": 5.2,
"units": "TB"
},
"localStorageUsed": {
"size": 2.1,
"units": "TB"
},
"model": "S5-2",
"name": "ACME-SIRIS",
"offsiteStorageUsed": {
"size": 1.9,
"units": "TB"
},
"registrationDate": "2024-02-14T10:12:00+00:00",
"remoteWebUrl": "https://device.dattobackup.com/sirisReporting/remoteWeb/A1B2C3D4E5F6",
"resellerCompanyName": "Contoso IT",
"serialNumber": "A1B2C3D4E5F6",
"servicePeriod": "2027-02-14T00:00:00+00:00",
"servicePlan": "Infinite Cloud Retention",
"shareCount": 1,
"uptime": 1296000,
"warrantyExpire": "2027-02-14T00:00:00+00:00"
}
],
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
}
}List Direct-to-Cloud assets
List the machines backed up straight to the Datto cloud (Direct-to-Cloud), for every client or for one.
Inputs
- Client ID
client_idnumber - Only this client's assets: the client's number, as 'List Direct-to-Cloud assets' shows it. Leave empty for every client.At least 1.
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
assetslist- The assets, as Datto gives them
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
Example output
{
"assets": [
{
"assetUuid": "123e4567-e89b-12d3-a456-426614174000",
"clientId": 7890,
"name": "LAPTOP-JO"
}
],
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
}
}List Direct-to-Cloud RMM templates
List the RMM templates that install Direct-to-Cloud agents, for every client or for one.
Inputs
- Client ID
client_idnumber - Only this client's templates: the client's number. Leave empty for every client.At least 1.
Outputs
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
templateslist- The templates, as Datto gives them
Example output
{
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"templates": [
{
"id": 12,
"name": "Acme workstations"
}
]
}List Endpoint Backup agents
List the Endpoint Backup for PCs clients and the agents under each one.
Inputs
- Page
pagenumber - Which page to return, starting at 1.At least 1.
- Page size
per_pagenumber - How many to return per page, 1 to 100. Datto's default is 100.From 1 to 100.
Outputs
clientslist- The clients and their agents, as Datto gives them
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
Example output
{
"clients": [
{
"agents": [
{
"name": "LAPTOP-JO"
}
],
"clientName": "Acme Corp"
}
],
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
}
}List SaaS applications
Get a SaaS Protection customer's backup report per application (mail, OneDrive, SharePoint and so on): storage used and recent backup history.
Inputs
- SaaS Protection customer
saas_customer_idtextRequired - The SaaS Protection customer. Pick one, or give its id from 'List SaaS domains'.
- Days of history
days_untilnumber - How many days of backup history to include, 0 to 365.From 0 to 365.
- Include seat ids
include_remote_idstrue/false - Also list the seat ids under each application.
Outputs
applicationslist- The reports, as Datto gives them
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
saas_customer_idnumber- The SaaS Protection customer's id
Example output
{
"applications": [
{
"customerId": 123456,
"customerName": "Acme Corp",
"suites": [
{
"appTypes": [],
"suiteType": "Office365"
}
],
"usedBytes": 53687091200
}
],
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"saas_customer_id": 123456
}List SaaS domains
List the Microsoft 365 and Google Workspace domains SaaS Protection backs up, with each customer's id, subscription id and seats used.
Inputs
None.
Outputs
countnumber- How many came back on this page
domainslist- The domains
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
Example output
{
"count": 1,
"domains": [
{
"domain": "acme.com",
"externalSubscriptionId": "Classic:Office365:654321",
"organizationId": 7890,
"organizationName": "Acme Corp",
"productType": "Office365",
"retentionType": "Infinite Cloud Retention",
"saasCustomerId": 123456,
"saasCustomerName": "Acme Corp",
"seatsUsed": 42
}
],
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
}
}List SaaS seats
List a SaaS Protection customer's seats (users, shared mailboxes, sites, teams and shared drives) and whether each is protected, paused or unprotected.
Inputs
- SaaS Protection customer
saas_customer_idtextRequired - The SaaS Protection customer. Pick one, or give its id from 'List SaaS domains'.
- Seat type
seat_typetext - Only seats of this type. Leave empty for every type.One of:
User(User (mailbox or Google user)),SharedMailbox(Shared mailbox (Microsoft 365)),Site(SharePoint site (Microsoft 365)),TeamSite(Team site (Microsoft 365)),Team(Team (Microsoft 365)),SharedDrive(Shared drive (Google Workspace)).
Outputs
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
saas_customer_idnumber- The SaaS Protection customer's id
seatslist- The seats
Example output
{
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"saas_customer_id": 123456,
"seats": [
{
"billable": "1",
"dateAdded": "2025-06-01T12:00:00+00:00",
"mainId": "jo@acme.com",
"name": "Jo Bloggs",
"remoteId": "ab23f1c4-bdf2-4a34-9a1d-1234567890ab",
"seatState": "Active",
"seatType": "User"
}
]
}List VM restores
List the virtual machines running on a BCDR device from its backups: restores and virtualizations in progress.
Inputs
- Device
serial_numbertextRequired - The BCDR device. Pick one, or give its serial number from an earlier step.
Outputs
countnumber- How many came back on this page
has_moretrue/false- True if Datto has another page after this one
paginationobject- Datto's paging
restoreslist- The VM restores, as Datto gives them
serial_numbertext- The device's serial number
Example output
{
"count": 1,
"has_more": false,
"pagination": {
"count": 1,
"page": 1,
"perPage": 100,
"totalPages": 1
},
"restores": [
{
"agentName": "FS01",
"createdDate": "2026-11-16T10:00:00+00:00",
"status": "running",
"vmName": "FS01-restore"
}
],
"serial_number": "A1B2C3D4E5F6"
}Set Direct-to-Cloud agent bandwidth
Set how much bandwidth a Direct-to-Cloud agent may use for backups, normally and when throttled, and whether it pauses on a metered connection.
Inputs
- Agent UUID
agent_uuidtextRequired - The Direct-to-Cloud agent's UUID.
- Maximum bandwidth (Mbps)
max_bandwidth_mbpsnumberRequired - The most it may use, in megabits per second.At least 0.001.
- Throttled bandwidth (Mbps)
max_throttled_bandwidth_mbpsnumberRequired - The most it may use while throttled, in megabits per second.At least 0.001.
- Pause on metered connections
pause_while_meteredtrue/false - Pause backups while the machine is on a metered connection.
Outputs
agent_uuidtext- The agent changed
responseobject- Datto's answer, as it gives it
settingsobject- What was sent: bits per second and the metered switch
updatedtrue/false- Always true once Datto accepted it
Example output
{
"agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"response": {},
"settings": {
"maximumBandwidthInBits": 100000000,
"maximumThrottledBandwidthInBits": 20000000,
"pauseWhileMetered": false
},
"updated": true
}