Druva

App · 25 actions

Manage Druva data protection: add, update, preserve and remove inSync users, follow their devices, backups and restores, start a restore, run legal holds, and read alerts and events. Start workflows on new users and devices, finished backups and restores, alerts and legal hold changes.

Actions

ActionWhat it does
Activate userMake a preserved user active again: their devices are enabled and their backups resume.
Add people to legal holdPut people on a legal hold by their email address, so their backed-up data is kept.
Create legal holdCreate a legal hold policy, so the data of the people put on it is kept and reviewers can reach it.
Create userAdd a person to Druva inSync so their devices and apps can be backed up, with a profile, a storage and optionally a quota.
Delete legal holdDelete a legal hold policy.
Delete userDelete a user with all their devices and backed-up data, freeing their licence.
Disable deviceDisable a device: its backups stop and nothing can be restored onto it.
Enable deviceEnable a disabled device so it backs up and can be restored to again.
Get deviceGet one device: its owner, platform, status, inSync Client version, how much is backed up and when it last connected.
Get legal holdGet one legal hold policy: its type, what data it gives access to, how many people are on it and its WebDAV addresses.
Get restoreGet one restore: whether it is still running, succeeded or failed (and why), and how many files it restored.
Get userGet one inSync user: their email, status, profile, storage and quota.
List alertsList Enterprise Workloads alerts, such as failed backup jobs, storage or CloudCache problems, with their severity and status, filtered by organization, type, workload or time.
List devicesList the laptops, desktops and phones inSync backs up, with their owner, platform, status, client version and last connection, filtered by any of those.
List eventsRead the Druva Cloud Platform's events: sign-ins, admin actions, backup jobs and alerts across Druva's products, filtered by product, category, type or severity.
List last backupsList each device's last successful backup: when it ran, how many files it backed up or missed, and its size.
List legal holdsList the legal hold policies, with their type, data access and how many people are on each, filtered by name, type or person.
List people on legal holdList the people (custodians) on a legal hold, with how much of their data has been collected.
List profilesList inSync's profiles: the backup settings each group of users shares.
List restoresList restores of devices' data from the last year, with their status, size and who started them, filtered by device, user or time.
List usersList the people Druva inSync backs up, with their email, status, profile and quota, filtered by email, name, status, profile, storage or when they were added.
Preserve userPreserve a user, such as when someone leaves: their backups stop and their devices are disabled, but their backed-up data is kept while they stay preserved.
Remove people from legal holdTake people off a legal hold by their email address.
Start restoreRestore a device's latest backup onto it, or onto another of the same person's devices: to a new desktop folder, to where the files came from, or to a folder you name.
Update userChange an inSync user's name, profile or storage.

Activate user

Make a preserved user active again: their devices are enabled and their backups resume.

Inputs

Userdruva_user_idtextRequired
The inSync user. Pick one, or give their id from an earlier step.

Outputs

activatedtrue/false
Always true once activated
druva_user_idnumber
The user's id
Example output
{
  "activated": true,
  "druva_user_id": 1
}

Put people on a legal hold by their email address, so their backed-up data is kept. Says who was added, who already was, and who isn't an inSync user.

Inputs

Legal holdpolicy_idtextRequired
The legal hold. Pick one, or give its id from an earlier step.
PeopleemailslistRequired
The people, by the email address of their inSync user. Pick them, or give addresses from an earlier step. Up to 500 at a time.

Outputs

addedlist
The addresses put on the legal hold
messagetext
Druva's summary
not_addedlist
Addresses already on a legal hold
not_in_druvalist
Addresses that aren't inSync users
policy_idnumber
The legal hold's id
Example output
{
  "added": [
    "john.doe@example.com"
  ],
  "message": "Custodian(s) added to legal hold successfully.",
  "not_added": [],
  "not_in_druva": [],
  "policy_id": 20
}

Create a legal hold policy, so the data of the people put on it is kept and reviewers can reach it. Add people with 'Add people to legal hold'.

Inputs

NamenametextRequired
The legal hold's name.
Data to give access todata_accesstextRequired
Which of the held people's data reviewers can reach: all of it, only the last collected, or only what falls within the dates below.One of: All Collected Data, Last Collected Data (Only the last collected data), Data within a Date Range.
Typelegal_hold_typetext
Legal, Human Resources, Information Security, or a type your account defines. Leave empty for none.
Fromstart_datedate
First day of the date range. Only for data within a date range.
Untilend_datedate
Last day of the date range. Only for data within a date range.
Deleted files onlydeleted_files_onlytrue/false
Give access only to files the people have deleted.

Outputs

nametext
Its name
policy_idnumber
The new legal hold's id
Example output
{
  "name": "Acme litigation 2026",
  "policy_id": 12359
}

Create user

Add a person to Druva inSync so their devices and apps can be backed up, with a profile, a storage and optionally a quota.

Inputs

Nameuser_nametextRequired
The person's name, as inSync shows it.
EmailemailtextRequired
The person's email address.
Profileprofile_idtextRequired
The profile whose backup settings the user gets.
Storagestorage_idtextRequired
The storage the user's backups go to.
Storage quotaquotanumber
How much the user may back up, 0 to 1023, in the unit chosen below it. Leave empty for the profile's quota.From 0 to 1023.
Quota unitquota_unittext
The unit of the storage quota. Defaults to GB.One of: MB, GB, TB.
Email them a passwordsend_password_emailtrue/false
Send the person an email to set their inSync password. Druva's default is not to.

Outputs

userobject
A Druva inSync user
Example output
{
  "user": {
    "addedOn": "2026-10-25T00:00:00Z",
    "additionalProperties": {},
    "emailID": "ernie.carter@example.com",
    "ldapGUID": "B1C47201C67910458867BA19982E353E",
    "privacySettingsEnabled": false,
    "profileID": 1,
    "quota": "10 GB",
    "quotaInBytes": 10737418240,
    "status": "active",
    "storageID": 1,
    "userID": 1,
    "userName": "Ernie Carter"
  }
}

Delete a legal hold policy. The people on it come off hold, so Druva's usual retention applies to their data again.

Inputs

Legal holdpolicy_idtextRequired
The legal hold. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
policy_idnumber
The legal hold's id
Example output
{
  "deleted": true,
  "policy_id": 12359
}

Delete user

Delete a user with all their devices and backed-up data, freeing their licence. Druva lets an administrator roll this back for a while under Rollback Actions.

Inputs

Userdruva_user_idtextRequired
The inSync user. Pick one, or give their id from an earlier step.
Reasonreasontext
Why, 10 to 150 characters, shown in Druva. Druva's default is API initiated User Deletion.

Outputs

deletedtrue/false
Always true once deleted
druva_user_idnumber
The user's id
Example output
{
  "deleted": true,
  "druva_user_id": 1
}

Disable device

Disable a device: its backups stop and nothing can be restored onto it. Its data stays in Druva and can be restored to the person's other devices.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its id from an earlier step.

Outputs

device_idnumber
The device's id
disabledtrue/false
Always true once disabled
Example output
{
  "device_id": 12345,
  "disabled": true
}

Enable device

Enable a disabled device so it backs up and can be restored to again.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its id from an earlier step.

Outputs

device_idnumber
The device's id
enabledtrue/false
Always true once enabled
Example output
{
  "device_id": 12345,
  "enabled": true
}

Get device

Get one device: its owner, platform, status, inSync Client version, how much is backed up and when it last connected.

Inputs

Devicedevice_idtextRequired
The device. Pick one, or give its id from an earlier step.

Outputs

deviceobject
A device inSync backs up
Example output
{
  "device": {
    "addedOn": "2026-10-25T00:00:00Z",
    "clientVersion": "7.5.0 r56746",
    "deviceID": 12345,
    "deviceMarkedInactive": false,
    "deviceName": "Ernie Carter's MacBook",
    "deviceOS": "macOS",
    "deviceOSVersion": "14.5",
    "deviceStatus": "enabled",
    "disabledMode": "",
    "disabledOn": "",
    "lastConnected": "2026-11-16T08:12:00Z",
    "lastUpgradedOn": "2026-10-25T00:00:00Z",
    "platformOS": "darwin",
    "serialNumber": "PX045",
    "totalBackupData": "40.05 GB",
    "totalBackupDataInBytes": 43003360051,
    "upgradeState": "UPTODATE",
    "userID": 1,
    "uuid": "TY5h67-5674r-675645"
  }
}

Get one legal hold policy: its type, what data it gives access to, how many people are on it and its WebDAV addresses.

Inputs

Legal holdpolicy_idtextRequired
The legal hold. Pick one, or give its id from an earlier step.

Outputs

legal_holdobject
A legal hold policy
Example output
{
  "legal_hold": {
    "accessAdditionalData": false,
    "accessBackupData": true,
    "collectionFrequency": "Not collecting",
    "createdBy": "Ernie Carter",
    "createdOn": "Nov 01 2026, 08:54",
    "deletedFilesOnly": false,
    "directDownLoadLink": "https://downloads.druva.com/insync/webdav/1-2/",
    "endDate": "",
    "isADCEnabled": false,
    "legalHoldType": "Legal",
    "legalHoldTypeId": 132,
    "name": "Acme litigation",
    "policyId": 20,
    "startDate": "",
    "usersCount": 7,
    "webDavAccessType": "All Collected Data",
    "webDavAccessUrls": [
      "https://restore-c22-cloud.druva.com/webdav/Mike"
    ]
  }
}

Get restore

Get one restore: whether it is still running, succeeded or failed (and why), and how many files it restored.

Inputs

Restore IDrestore_idtextRequired
The restore's id, from 'Start restore', 'List restores' or the Restore finished trigger.

Outputs

restoreobject
A restore of a device's backed-up data
Example output
{
  "restore": {
    "deviceID": 12345,
    "endTime": "2026-11-16T09:13:36Z",
    "failureReason": "",
    "numberOfFilesMissed": 0,
    "numberOfFilesRestored": 456,
    "restoreID": 4567,
    "restoreLocation": "Desktop",
    "restoreMode": "Admin",
    "restoreSize": "285 MB",
    "startTime": "2026-11-16T09:12:36Z",
    "status": "Successful",
    "systemSettingsRestore": false,
    "targetDeviceID": 12345,
    "userID": 1
  }
}

Get user

Get one inSync user: their email, status, profile, storage and quota.

Inputs

Userdruva_user_idtextRequired
The inSync user. Pick one, or give their id from an earlier step.

Outputs

userobject
A Druva inSync user
Example output
{
  "user": {
    "addedOn": "2026-10-25T00:00:00Z",
    "additionalProperties": {},
    "emailID": "ernie.carter@example.com",
    "ldapGUID": "B1C47201C67910458867BA19982E353E",
    "privacySettingsEnabled": false,
    "profileID": 1,
    "quota": "10 GB",
    "quotaInBytes": 10737418240,
    "status": "active",
    "storageID": 1,
    "userID": 1,
    "userName": "Ernie Carter"
  }
}

List alerts

List Enterprise Workloads alerts, such as failed backup jobs, storage or CloudCache problems, with their severity and status, filtered by organization, type, workload or time.

Inputs

Organizationorg_idtext
Only this Enterprise Workloads organization's alerts. Leave empty for every organization.
Typealert_typetext
Only alerts of this type. Backup failures adds each failed job's details. Leave empty for every type.One of: backupFailures (Backup failures), jobs, cloudcache, license, upgrade, configuration, seeding, oracle, billing.
Workloadworkload_typetext
Only alerts about this kind of workload.One of: vmware, hyperv (Hyper-V), fs (File server), nas, sql (SQL Server), oracle.
Resourceresource_typetext
Only alerts about this kind of resource.One of: vmwareVM (VMware virtual machine), hyperVM (Hyper-V virtual machine), physicalServer (Physical server), nasShare (NAS share), sqlStandaloneInstance (SQL Server instance), sqlAvailabilityGroup (SQL Server availability group), oracle.
Raised aftergenerated_afterdate and time
Only alerts raised after this time, at most six months ago.
Raised beforegenerated_beforedate and time
Only alerts raised before this time.
Next page tokenpage_tokentext
The 'next_page_token' from an earlier run of this step, to get the page after it. Leave empty for the first page.

Outputs

alertslist
The alerts
countnumber
How many came back on this page
next_page_tokentext
The token for the next page, for 'Next page token'; empty on the last page
Example output
{
  "alerts": [
    {
      "OrgID": 1,
      "alertDetails": {
        "failedJobIDs": [
          1
        ],
        "jobEndTime": "2026-11-16T05:52:36.000Z",
        "jobErrorMsg": "Backup failed: the VM could not be reached",
        "jobID": 1,
        "jobStartTime": "2026-11-16T03:38:22.000Z",
        "lastSucceeded": "2026-11-15T03:38:22.000Z"
      },
      "generatedOn": "2026-11-16T05:08:16Z",
      "id": 1,
      "resolutionTime": "NA",
      "resourceInfo": {
        "vmName": "web-01"
      },
      "resourceName": "web-01",
      "resourceType": "vmwareVM",
      "severity": "critical",
      "status": "active",
      "subtype": "backupFailures",
      "targetID": 1,
      "targetType": "jobs",
      "type": "jobs",
      "workloadType": "vmware"
    }
  ],
  "count": 1,
  "next_page_token": ""
}

List devices

List the laptops, desktops and phones inSync backs up, with their owner, platform, status, client version and last connection, filtered by any of those.

Inputs

Userdruva_user_idtext
Only this user's.
Profilesprofile_idslist
Only devices of users with these profiles.
Name starts withname_prefixtext
Only devices whose name starts with this, such as MyDevice.
Platformplatformtext
Only devices on this platform. Leave empty for all.One of: win32 (Windows), darwin (macOS), linux2 (Linux), android, ios.
Statusdevice_statustext
Only enabled or only disabled devices. Leave empty for both.One of: enabled, disabled.
inSync Client upgradeupgrade_statetext
Only devices whose inSync Client is in this state.One of: UPTODATE (Up to date), UPGRADABLE (Can be upgraded), SCHEDULED (Upgrade scheduled), NOT UPGRADABLE (Can't be upgraded), UNKNOWN.
Inactivemarked_inactivetext
Only devices marked inactive, or only those not. Leave empty for both.One of: true (Only devices marked inactive), false (Only devices not marked inactive).
Serial numberserial_numbertext
Only the device with this serial number.
Last connected afterlast_connected_afterdate and time
Only devices that last connected after this time.
Last connected beforelast_connected_beforedate and time
Only devices that last connected before this time, such as to find ones not seen for a month.
Added afteradded_afterdate and time
Only devices added after this time.
Added beforeadded_beforedate and time
Only devices added before this time.
Next page tokenpage_tokentext
The 'next_page_token' from an earlier run of this step, to get the page after it. Leave empty for the first page.

Outputs

countnumber
How many came back on this page
deviceslist
The devices
next_page_tokentext
The token for the next page, for 'Next page token'; empty on the last page
totalnumber
How many devices match, across every page
Example output
{
  "count": 1,
  "devices": [
    {
      "addedOn": "2026-10-25T00:00:00Z",
      "clientVersion": "7.5.0 r56746",
      "deviceID": 12345,
      "deviceMarkedInactive": false,
      "deviceName": "Ernie Carter's MacBook",
      "deviceOS": "macOS",
      "deviceOSVersion": "14.5",
      "deviceStatus": "enabled",
      "disabledMode": "",
      "disabledOn": "",
      "lastConnected": "2026-11-16T08:12:00Z",
      "lastUpgradedOn": "2026-10-25T00:00:00Z",
      "platformOS": "darwin",
      "serialNumber": "PX045",
      "totalBackupData": "40.05 GB",
      "totalBackupDataInBytes": 43003360051,
      "upgradeState": "UPTODATE",
      "userID": 1,
      "uuid": "TY5h67-5674r-675645"
    }
  ],
  "next_page_token": "",
  "total": 1
}

List events

Read the Druva Cloud Platform's events: sign-ins, admin actions, backup jobs and alerts across Druva's products, filtered by product, category, type or severity. Gets one page; run it again with the next page token for more.

Inputs

Productproducttext
Only events from this Druva product. Leave empty for every product.One of: 4097 (Druva Cloud Platform), 8193 (Endpoints and SaaS apps (inSync)), 8197 (Data Governance), 8196 (Salesforce), 12289 (Enterprise Workloads), 36880 (Cyber Resilience).
Categorycategorytext
Only events, alerts or audit trail entries. Leave empty for all.One of: EVENT (Events), ALERT (Alerts), AUDIT (Audit trail).
Event typeevent_typetext
Only events of this type, as Druva names it, such as Login or Job Ended.
Featurefeaturetext
Only events from this part of Druva, such as Admin Event or Job.
Severityseveritytext
Only events of exactly this severity. Leave empty for every severity.One of: 0 (Emergency (0)), 1 (Alert (1)), 2 (Critical (2)), 3 (Error (3)), 4 (Warning (4)), 5 (Notice (5)), 6 (Informational (6)), 7 (Debug (7)).
How manypage_sizenumber
How many events to return, 1 to 500. Druva's default is 500.From 1 to 500.
Next page tokenpage_tokentext
The 'next_page_token' from an earlier run of this step, to get the events after it. Druva then ignores the other filters and uses the ones the first page was read with.

Outputs

countnumber
How many came back on this page
eventslist
The events
next_page_tokentext
The token for the next page, for 'Next page token'; empty on the last page
Example output
{
  "count": 1,
  "events": [
    {
      "category": "EVENT",
      "details": {
        "email": "ernie.carter@example.com",
        "sourceIP": "203.0.113.10",
        "status": "Success"
      },
      "feature": "Admin Event",
      "globalID": "axe12345-1abc-4def-8abc-5abcdef01234",
      "productID": 4097,
      "syslogFacility": 23,
      "syslogSeverity": 6,
      "timeStamp": 1763370000,
      "type": "Password Verified"
    }
  ],
  "next_page_token": ""
}

List last backups

List each device's last successful backup: when it ran, how many files it backed up or missed, and its size. Filter by device, user or time.

Inputs

Devicedevice_idtext
Only this device's.
Userdruva_user_idtext
Only this user's.
Started afterstarted_afterdate and time
Only backups that started after this time.
Started beforestarted_beforedate and time
Only backups that started before this time.
Ended afterended_afterdate and time
Only backups that ended after this time.
Ended beforeended_beforedate and time
Only backups that ended before this time.
Next page tokenpage_tokentext
The 'next_page_token' from an earlier run of this step, to get the page after it. Leave empty for the first page.

Outputs

backupslist
The backups
countnumber
How many came back on this page
next_page_tokentext
The token for the next page, for 'Next page token'; empty on the last page
Example output
{
  "backups": [
    {
      "backupStatus": "Completed",
      "bytesTransferred": 23456,
      "deviceID": 12345,
      "endTime": "2026-11-16T08:12:00Z",
      "filesBackedUp": 124,
      "filesMissed": 0,
      "snapshotSize": "2546 MB",
      "startTime": "2026-11-16T08:00:00Z",
      "systemSettingsBackedUp": true
    }
  ],
  "count": 1,
  "next_page_token": ""
}

List the legal hold policies, with their type, data access and how many people are on each, filtered by name, type or person.

Inputs

Name containssearchtext
Only legal holds whose name matches this.
With these peoplecustodian_emailslist
Only legal holds these people are on.
Typelegal_hold_typetext
Only legal holds of this type. Leave empty for every type.One of: Legal, Human Resources, Information Security.
Sort bysort_bytext
What to sort them by.One of: createdOn (Date created), name.
Ordersort_ordertext
Ascending or descending.One of: asc (Ascending), desc (Descending).

Outputs

countnumber
How many came back on this page
legal_holdslist
The legal holds
Example output
{
  "count": 1,
  "legal_holds": [
    {
      "createdBy": "Ernie Carter",
      "createdOn": "Nov 01 2026, 08:54",
      "deletedFilesOnly": false,
      "endDate": "",
      "isADCEnabled": false,
      "legalHoldType": "Legal",
      "legalHoldTypeId": 132,
      "name": "Acme litigation",
      "numberOfCustodians": 7,
      "policyId": 20,
      "startDate": "",
      "webDavAccessType": "All Collected Data"
    }
  ]
}

List the people (custodians) on a legal hold, with how much of their data has been collected.

Inputs

Legal holdpolicy_idtextRequired
The legal hold. Pick one, or give its id from an earlier step.
Name or email starts withsearchtext
Only people whose name or email starts with this.
Ordersort_ordertext
Sort by name, ascending or descending.One of: asc (Ascending), desc (Descending).
Pagepage_numbernumber
Which page to get, from 1. Defaults to the first.At least 1.
How manypage_sizenumber
How many people a page, 1 to 500.From 1 to 500.

Outputs

countnumber
How many came back on this page
custodianslist
The people on the legal hold
page_numbernumber
This page's number
total_custodiansnumber
How many people are on it in all
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "custodians": [
    {
      "collectedData": "1.68 GB",
      "collectedDataInBytes": 1800010372,
      "numberOfDataSources": 2,
      "onLegalHold": true,
      "policyId": 20,
      "status": "Active",
      "totalCollectedData": "2.12 GB",
      "totalCollectedDataInBytes": 2276332666,
      "userEmail": "john.doe@example.com",
      "userId": 3,
      "userName": "John Doe"
    }
  ],
  "page_number": 1,
  "total_custodians": 1,
  "total_pages": 1
}

List profiles

List inSync's profiles: the backup settings each group of users shares.

Inputs

Next page tokenpage_tokentext
The 'next_page_token' from an earlier run of this step, to get the page after it. Leave empty for the first page.

Outputs

countnumber
How many came back on this page
next_page_tokentext
The token for the next page, for 'Next page token'; empty on the last page
profileslist
The profiles
Example output
{
  "count": 1,
  "next_page_token": "",
  "profiles": [
    {
      "profileDescription": "Default profile with pre-configured values",
      "profileID": 1,
      "profileName": "Default"
    }
  ]
}

List restores

List restores of devices' data from the last year, with their status, size and who started them, filtered by device, user or time.

Inputs

From devicedevice_idtext
Only restores of this device's data.
To devicetarget_device_idtext
Only restores onto this device.
Userdruva_user_idtext
Only this user's.
Started afterstarted_afterdate and time
Only restores that started after this time. Druva keeps a year of them.
Started beforestarted_beforedate and time
Only restores that started before this time.
Next page tokenpage_tokentext
The 'next_page_token' from an earlier run of this step, to get the page after it. Leave empty for the first page.

Outputs

countnumber
How many came back on this page
next_page_tokentext
The token for the next page, for 'Next page token'; empty on the last page
restoreslist
The restores
Example output
{
  "count": 1,
  "next_page_token": "",
  "restores": [
    {
      "deviceID": 12345,
      "endTime": "2026-11-16T09:13:36Z",
      "failureReason": "",
      "numberOfFilesMissed": 0,
      "numberOfFilesRestored": 456,
      "restoreID": 4567,
      "restoreLocation": "Desktop",
      "restoreMode": "Admin",
      "restoreSize": "285 MB",
      "startTime": "2026-11-16T09:12:36Z",
      "status": "Successful",
      "systemSettingsRestore": false,
      "targetDeviceID": 12345,
      "userID": 1
    }
  ]
}

List users

List the people Druva inSync backs up, with their email, status, profile and quota, filtered by email, name, status, profile, storage or when they were added.

Inputs

Emailemailtext
Only the user with exactly this email address.
Email starts withemail_prefixtext
Only users whose email address starts with this, such as ernie.
Name starts withname_prefixtext
Only users whose name starts with this, such as Ern.
Statusstatustext
Only active or only preserved users. Leave empty for both.One of: active, preserved.
Profileprofile_idtext
Only users with this profile.
Storagestorage_idtext
Only users whose backups go to this storage.
Added afteradded_afterdate and time
Only users added after this time.
Added beforeadded_beforedate and time
Only users added before this time.
Next page tokenpage_tokentext
The 'next_page_token' from an earlier run of this step, to get the page after it. Leave empty for the first page.

Outputs

countnumber
How many came back on this page
next_page_tokentext
The token for the next page, for 'Next page token'; empty on the last page
totalnumber
How many users match, across every page
userslist
The users
Example output
{
  "count": 1,
  "next_page_token": "",
  "total": 1,
  "users": [
    {
      "addedOn": "2026-10-25T00:00:00Z",
      "additionalProperties": {},
      "emailID": "ernie.carter@example.com",
      "ldapGUID": "B1C47201C67910458867BA19982E353E",
      "privacySettingsEnabled": false,
      "profileID": 1,
      "quota": "10 GB",
      "quotaInBytes": 10737418240,
      "status": "active",
      "storageID": 1,
      "userID": 1,
      "userName": "Ernie Carter"
    }
  ]
}

Preserve user

Preserve a user, such as when someone leaves: their backups stop and their devices are disabled, but their backed-up data is kept while they stay preserved.

Inputs

Userdruva_user_idtextRequired
The inSync user. Pick one, or give their id from an earlier step.

Outputs

druva_user_idnumber
The user's id
preservedtrue/false
Always true once preserved
Example output
{
  "druva_user_id": 1,
  "preserved": true
}

Take people off a legal hold by their email address. Says who was removed and who wasn't on it.

Inputs

Legal holdpolicy_idtextRequired
The legal hold. Pick one, or give its id from an earlier step.
PeopleemailslistRequired
The people, by the email address of their inSync user. Pick them, or give addresses from an earlier step. Up to 500 at a time.

Outputs

messagetext
Druva's summary
not_in_druvalist
Addresses that aren't inSync users
not_removedlist
Addresses that weren't on it
policy_idnumber
The legal hold's id
removedlist
The addresses taken off the legal hold
Example output
{
  "message": "Custodian(s) removed from legal hold successfully.",
  "not_in_druva": [],
  "not_removed": [],
  "policy_id": 20,
  "removed": [
    "john.doe@example.com"
  ]
}

Start restore

Restore a device's latest backup onto it, or onto another of the same person's devices: to a new desktop folder, to where the files came from, or to a folder you name.

Inputs

From devicedevice_idtextRequired
The device whose latest backup to restore.
Restore torestore_locationtextRequired
Where on the device the files go.One of: Desktop (A new folder on the desktop), Original (Where the files were backed up from (replaces them)), custom (A folder I name).
To devicetarget_device_idtext
Another device of the same person to restore onto. Leave empty to restore onto the device the data came from.
Foldercustom_foldertext
The full path of the folder to restore into, such as /Users/ernie/Restored. Only for 'A folder I name'.
Scan for malware firstscan_for_malwaretrue/false
Scan the backup for malware before restoring it. Needs Druva's Restore With Confidence licence.

Outputs

restoreobject
The restore started
restoreslist
Every restore Druva started
Example output
{
  "restore": {
    "deviceID": 12345,
    "endTime": "",
    "failureReason": "",
    "numberOfFilesMissed": 0,
    "numberOfFilesRestored": 456,
    "restoreID": 4567,
    "restoreLocation": "Desktop",
    "restoreMode": "Admin",
    "restoreSize": "",
    "startTime": "2026-11-16T09:12:36Z",
    "status": "Ongoing",
    "systemSettingsRestore": false,
    "targetDeviceID": 12345,
    "userID": 1
  },
  "restores": [
    {
      "deviceID": 12345,
      "endTime": "",
      "failureReason": "",
      "numberOfFilesMissed": 0,
      "numberOfFilesRestored": 456,
      "restoreID": 4567,
      "restoreLocation": "Desktop",
      "restoreMode": "Admin",
      "restoreSize": "",
      "startTime": "2026-11-16T09:12:36Z",
      "status": "Ongoing",
      "systemSettingsRestore": false,
      "targetDeviceID": 12345,
      "userID": 1
    }
  ]
}

Update user

Change an inSync user's name, profile or storage. Only the fields given change.

Inputs

Userdruva_user_idtextRequired
The inSync user. Pick one, or give their id from an earlier step.
Nameuser_nametext
A new name. Leave empty to keep it.
Profileprofile_idtext
A new profile. Leave empty to keep it.
Storagestorage_idtext
A new storage for the user's backups. Leave empty to keep it.

Outputs

userobject
A Druva inSync user
Example output
{
  "user": {
    "addedOn": "2026-10-25T00:00:00Z",
    "additionalProperties": {},
    "emailID": "ernie.carter@example.com",
    "ldapGUID": "B1C47201C67910458867BA19982E353E",
    "privacySettingsEnabled": false,
    "profileID": 1,
    "quota": "10 GB",
    "quotaInBytes": 10737418240,
    "status": "active",
    "storageID": 1,
    "userID": 1,
    "userName": "Ernie Carter"
  }
}

On this page