{"openapi":"3.0.0","info":{"version":"3.0","title":"inSync GovCloud"},"tags":[{"name":"User Management","description":"Lists the APIs to get information and perform operations on users managed in Druva inSync."},{"name":"Profile Management","description":"Lists the APIs to get information about the profiles configured in Druva inSync."},{"name":"Endpoints","description":"Lists the APIs to get information about devices managed in Druva inSync."},{"name":"Legal Hold","description":"Lists the APIs to get information about the legal hold policies, manage users on legal hold and new APIs for eDiscovery Download Client."},{"name":"Event Management","description":"Lists the APIs to get information about the events generated in Druva inSync."},{"name":"Storage Management","description":"Lists the APIs to get information about the storages and inSync CloudCache Servers configured in Druva inSync."},{"name":"AD/LDAP Management","description":"Lists the APIs to get information about the AD/LDAP Connectors configured for Endpoints & SaaS Apps."},{"name":"Audit Trail Management","description":"Lists the APIs to get information about the Audit Trails generated in the Druva Console."}],"paths":{"/usermanagement/v1/users":{"get":{"tags":["User Management"],"summary":"List all users","description":"Returns the list of users in Druva inSync with their details.","security":[{"Bearer":[]}],"parameters":[{"name":"profileID","in":"query","description":"Specify the profile ID to filter and get the list of users associated with a profile. Get the ID of a profile using the 'List all profiles' API.","required":false,"schema":{"type":"integer"}},{"name":"storageID","in":"query","description":"Specify the storage ID to filter and get the list of users associated with a particular storage. Get the ID of a storage using the 'List all storages' API.","required":false,"schema":{"type":"integer"}},{"name":"cacheID","in":"query","description":"Specify the CloudCache Server ID to get the list of users associated with a CloudCache Server. Get the ID of a CloudCache Server using the 'List all CloudCache Servers' API.","required":false,"schema":{"type":"integer"}},{"name":"userIDs","in":"query","description":"Specify unique user IDs, separated by commas, to get details of specific users.","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"emailID","in":"query","description":"Specify the email address to list a user's details.","required":false,"schema":{"type":"string"}},{"name":"searchPrefixEmailID","in":"query","description":"Specify the email prefix by which you intend to search and list the users. Example - In the email address 'ernie.carter@druva.com', 'ernie.carter' is the email prefix.","required":false,"schema":{"type":"string"}},{"name":"searchPrefixUserName","in":"query","description":"Specify the prefix from the user name by which you intend to search and list the users. Example, 'Ern' can be a prefix in the user name 'Ernie'.","required":false,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}},{"name":"minAddedOn","in":"query","description":"Specify the date and time to list users that are added to Druva inSync after it. The time should be specified in the UTC time zone. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"maxAddedOn","in":"query","description":"Specify the date and time to list users that are added to Druva inSync before it. he time should be specified in the UTC time zone. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"Specify the current status of user account to filter and list the users.","required":false,"schema":{"type":"string","enum":["active","preserved"]}},{"name":"ldapGUID","in":"query","description":"Specify the AD or LDAP object GUID to get the list of users associated with it. Pass the parameter as a hex string. Example: B1C47201C67910458867BA19982E353E","required":false,"schema":{"type":"string"}},{"name":"privacySettingsEnabled","in":"query","required":false,"description":"List users based on the status of their privacy settings. For example, if you select True, all the users with their privacy setting enabled are listed.","schema":{"type":"boolean","enum":["true","false"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["User Management"],"summary":"Create a new user","description":"Creates a new user in Druva inSync with the settings defined in this API.","security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"To create a user in Druva inSync.","required":["userName","profileID","storageID","emailID"],"properties":{"userName":{"description":"Specify the username for the user in Druva inSync. Example - Ernie Carter","type":"string","example":"Ernie Carter"},"profileID":{"description":"Specify the ID of the profile to be associated with the user account. Get the ID of a profile using the 'List all profiles' API.","type":"integer","example":2},"storageID":{"description":"Specify the ID of the storage on which the user data backed up by inSync should be stored. Get the ID of a storage using the 'List all storages' API.","type":"integer","example":2},"emailID":{"description":"Specify the email address of the user.","type":"string","example":"ernie.carter@druva.com"},"quota":{"description":"Specify the storage quota that should be allocated to the new user. \n Specify a value between 0 to 1023. Example - 1000  \n :fa-info-circle: If kept blank, the storage quota configured in the profile is assigned to the user.","type":"integer","example":"10"},"quotaUnit":{"description":"Specify the storage unit for the quota value (MB,GB, OR TB).","type":"string","enum":["MB","GB","TB"]},"sendPasswordByEmail":{"description":"Specify whether to send the password to the user by email. If false, password is not sent to the user. Default is true and password will be sent to the user's email address.","type":"boolean","example":true}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"400":{"description":"Bad Request. Provide an appropriate value in the range of 0 to 1023 for User quota."},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/usermanagement/v1/users/{userID}":{"get":{"tags":["User Management"],"summary":"Get user information using userID","description":"Returns information about a particular user in Druva inSync using the userID.","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"path","description":"The unique ID of a user in inSync. Get the ID of a user using the 'List all users' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"tags":["User Management"],"summary":"Update user information using userID","description":"Use this API to update username and profile of an existing user.","security":[{"Bearer":[]}],"parameters":[{"in":"path","name":"userID","description":"Specify the inSync user ID of the user for whom you want to update the username or profile. Get the ID of a user using the ‘List all users’ API.","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Specify the new value only for those parameters that you want to update for a user in Druva inSync.","properties":{"userName":{"description":"Specify the new username for the user.","type":"string","example":"Ernie Carter"},"profileID":{"description":"Specify the ID of the new profile that you want to associate with the user account. The new profile settings are applied to the user account in the next backup cycle.Get the profile ID using the 'List all profiles' API.\n :fa-info-circle: If you are changing user's profile to a profile where the Privacy Settings conflicts with the Privacy Settings in the old profile, which may result in administrators getting an unintentional access to the user's data, inSync does not allow you to update the profile. In such a case, you must request the inSync user to allow the inSync administrators to access their backed up data (setting on inSync Client) and try again.","type":"integer","example":2}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreate"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["User Management"],"summary":"Delete a user","description":"Deletes a user in the system. When you delete a user:\n 1. All the user data (restore points) is deleted.\n 2. If the user that is being deleted has shared data with guest users, this data is also deleted.\n 3. All devices of the user will get deleted, and all the active and preserved licenses that the user was consuming will be freed up.\n 4. You can roll back the deleted user from Rollback Actions until the rollback window lapses.\n 5. After the rollback window lapses, the user will be deleted permanently. For more information, see <a href=https://docs.druva.com/Cyber_Resilience/Rollback_Actions>Rollback Actions</a>.","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"path","description":"The unique ID of a user in inSync. Get the ID of a user using the 'List all users' API.","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deletionReason":{"description":"Specify the reason for user deletion (the character limit of reason is between 10-150) .  This capability will help prevent accidental deletions. If no reason is specified, the default reason i.e. <b>API initiated User Deletion</b> will be displayed.","type":"string","example":"User left the organization."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was unprocessable due to  semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/usermanagement/v1/users/{userID}/resetPassword":{"post":{"tags":["User Management"],"summary":"Reset password for a user","description":"Resets the password for the user identified using the userID. inSync sends an email with a password reset link to the user.","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"path","description":"The unique ID of a user in inSync. Get the ID of a user using the 'List all users' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/usermanagement/v1/users/{userID}/preserve":{"post":{"tags":["User Management"],"summary":"Preserve a user","description":"Preserves a user in Druva inSync.\nWhen you preserve a user:\n    1) Backups from the user's device are stopped and the user status changes to Preserved.\n    2) inSync retains the user's data backups as long as the user is Preserved.\n    3) If not activated again, the preserved user is later deleted from inSync after the duration specified in the  Auto-Delete Preserved User settings of the user's profile. ","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"path","description":"The unique ID of a user in inSync. Get the ID of a user using the 'List all users' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/usermanagement/v1/users/{userID}/activate":{"post":{"tags":["User Management"],"summary":"Activate a user","description":"Activates an already preserved user.\n When you activate a user:\n    1) The user status would change from Preserved to Active.\n    2) State of all devices assigned to this user would change from Disabled to Enabled.\n    3) Backups from the user's device(s) would resume as per the configuration.\n    4) Before activating a user, if a user has consumed, for example, one Endpoints preserved license, then post-activation one Endpoints preserved license is freed up and one Endpoints active license is consumed (the same rationale applies to all workloads).\n    5) The license state of all the workloads associated with this user would change from Preserved to Active only if the user has Active licenses available for all the associated workloads.\n For example, consider this scenario wherein you are trying to activate a user who has consumed one Endpoints preserved license, one Microsoft 365 preserved license, and one Google Workspace preserved license, but the user has only one Microsoft 365 Active license and one Google Workspace Active license available, and Endpoints Active license is not available, then:\n\ta. the user activation would fail, as there is no active Endpoints license available.\n\tb. the user will remain in a preserved state, and the license state of Microsoft 365, Google Workspace, and Endpoints would continue to remain in the preserved state.","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"path","description":"The unique ID of a user in inSync. Get the ID of a user using the 'List all users' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/usermanagement/v1/users/{userID}/download_user_auth_key":{"get":{"tags":["User Management"],"summary":"Download AuthKey","description":"Downloads the authentication key for users to replace or add a new device","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"path","description":"The unique ID of a user in inSync. Get the ID of a user using the 'List all users' API.\n :fa-info-circle: Download the output in an IDK file.","required":true,"schema":{"type":"integer"}},{"name":"deviceID","in":"query","description":"Specify the device ID to download the Authkey for replacing the existing device. Get the ID of a device using the 'List all devices' API.\n Do not specify the device ID to download the Authkey for adding a new device.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync Gov Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/profilemanagement/v1/profiles":{"get":{"tags":["Profile Management"],"summary":"List all profiles","description":"Returns a list of all the profiles configured in Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/profilemanagement/v1/profiles/{profileID}":{"get":{"tags":["Profile Management"],"summary":"Get profile information","description":"Returns the profile configuration details using the profileID.","security":[{"Bearer":[]}],"parameters":[{"name":"profileID","in":"path","description":"The unique ID of a profile in inSync. Get the ID of a profile using the ‘List all profiles’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Profile"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devices":{"get":{"tags":["Endpoints"],"summary":"List all devices - v1","description":"Returns information about all the user devices protected using Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"query","description":"Specify the user ID to get a list of devices associated with a single user. Get the ID of a user using the 'List all users' API.","required":false,"schema":{"type":"integer"}},{"name":"userIDs","in":"query","description":"Specify the user IDs, separated by commas, to get a list of devices associated with multiple users. Get the user IDs using the 'List all users' API.","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"deviceIDs","in":"query","description":"Filter the list of devices by specifying only the required device IDs, separated by commas. Get the device IDs by using this ‘List all devices’ API.","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"profileIDs","in":"query","description":"Specify the profile IDs, separated by commas, to get a list of devices associated with multiple profiles. Get the ID of a profile using the ‘List all profiles’ API.","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"searchPrefixDeviceName","in":"query","description":"Specify the prefix from the device name by which you intend to search and list the devices. Example - “My” is the prefix in the device name “MyDevice123”.","required":false,"schema":{"type":"string"}},{"name":"clientVersion","in":"query","description":"Filter the list of devices by the inSync Client version installed on it. Example - 6.2.0","required":false,"schema":{"type":"string"}},{"name":"platformOS","in":"query","required":false,"description":"Filter the list of devices by specifying the operating system of the device.","schema":{"type":"string","enum":["win32","linux2","darwin","android","ios"]}},{"name":"deviceStatus","in":"query","required":false,"description":"Filter the list by specifying the status of the device.","schema":{"type":"string","enum":["enabled","disabled"]}},{"name":"upgradeState","in":"query","required":false,"description":"The upgrade state of the device.","schema":{"type":"string","enum":["NOT UPGRADABLE","UPGRADABLE","UPTODATE","SCHEDULED","UNKNOWN"]}},{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}},{"name":"minLastConnected","in":"query","description":"Filter to list devices that are connected to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"maxLastConnected","in":"query","description":"Filter to list devices that are connected to Druva inSync before a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"minAddedOn","in":"query","description":"Filter to list devices that are added to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"maxAddedOn","in":"query","description":"Filter to list devices that are added to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"serialNumber","in":"query","description":"Get device information using the unique serial number assigned to an individual piece of hardware by the manufacturer.","required":false,"schema":{"type":"string"}},{"name":"uuid","in":"query","description":"Get device information using the unique 128-bit number UUID used to identify device on internet.","required":false,"schema":{"type":"string"}},{"name":"deviceMarkedInactive","in":"query","description":"Filter the list of devices that are marked as inactive. For example, if you select true, all devices that are marked as inactive are listed. For more information about inactive devices, see <a href=https://docs.druva.com/Endpoints/030_Set_up_inSync_for_Endpoints/010_Initial_Configuration/030_Create_and_manage_profiles/010_Create_a_profile>Create Profile</a>.","required":false,"schema":{"type":"boolean","enum":["true","false"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devices/{deviceID}":{"get":{"tags":["Endpoints"],"summary":"Get device information - v1","description":"Returns device information using deviceID.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"path","description":"The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Device"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"tags":["Endpoints"],"summary":"Delete a device","description":"Deletes a device in the system. When you delete a device:\n 1) All the device data (restore points) is deleted.\n 2) You can roll back the deleted device from Rollback Actions until the rollback window lapses.\n 3) After the rollback window lapses, the device will be deleted permanently. For more information, see <a href=https://docs.druva.com/Cyber_Resilience/Rollback_Actions>Rollback Actions</a>.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"path","description":"The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deletionReason":{"description":"Specify the reason for device deletion, (the character limit of reason is between 10-150) . This capability will help prevent accidental deletions. If no reason is specified, the default reason i.e. <b>API initiated Device Deletion</b> will be displayed.","type":"string","example":"Inactive device"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was unprocessable due to  semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devices/{deviceID}/disable":{"post":{"tags":["Endpoints"],"summary":"Disable a device","description":"Disables a user device. Once disabled, the data backup from the device stops, and the user can no longer restore data to that same device. The data of disabled device is available in inSync and can be restored to different devices belonging to the same user, either by the user or an administrator.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"path","description":"The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devices/{deviceID}/enable":{"post":{"tags":["Endpoints"],"summary":"Enable a device","description":"Enables a user's device. After the device is enabled, the user of the selected device can start taking its backup and restore.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"path","description":"The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devicemappings":{"post":{"tags":["Endpoints"],"summary":"Create device mapping","description":"Creates a secure user-to-device mapping to perform a mass deployment in a non-AD/LDAP environment or perform bulk replace of devices. The user-to-device mapping ensures controlled device and user activation of inSync client and prevents addition of rogue or unauthorized devices to inSync.","security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Device Mapping","required":["emailID","userName","deviceName","deviceIdentifierType","deviceIdentifier"],"properties":{"emailID":{"description":"Specify the email address of the user. Example - ernie.carter@druva.com","type":"string","example":"ernie.carter@druva.com"},"userName":{"description":"Specify the username of the user in Druva inSync. Example - Ernie Carter","type":"string","example":"Ernie Carter"},"deviceName":{"description":"Specify the name of the device that is registered with the user. Example - Ernie Carter's Macbook","type":"string","example":"ErnieCarter's Macbook"},"deviceIdentifierType":{"description":"Specify the unique device identifier type of the device.(serial-number, uuid, or hostname)","type":"string","example":"serial-number","enum":["serial-number","uuid","hostname"]},"deviceIdentifier":{"description":"Specify the unique device identifier for the selected type. (serial-number, uuid, or hostname).","type":"string","example":"P0XGGGH"},"oldDeviceName":{"description":"Name of the user's old device in Druva inSync that is to be replaced with a new device. \n\n:fa-info-circle: Note: Specify the value for this parameter only if you want to replace the device for the user, else keep this field blank.","type":"string","example":"ErnieCarter's Old Macbook"},"restoreData":{"description":"The type of data restore to be performed.(ALL, SYSTEM, OR DATA)\n Type of data to be restored on the new device.Specify one of the following value:\n 1) All - To restore both, the data and the system settings from the existing device on the new device.\n2) SYSTEM - To restore only the system settings from the existing device on the new device.\n3)DATA - To restore only the data from the existing device on the new device.\n\n:fa-info-circle: Note: Specify the value for this parameter only if you want to replace the device for the user, else keep this field blank.","type":"string","example":"SYSTEM","enum":["ALL","DATA","SYSTEM"]}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceMappingCreate"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"tags":["Endpoints"],"summary":"List device mapping","description":"Returns a list of user-to-device mapping created to perform a mass deployment in a non-AD/LDAP environment or perform bulk replace of devices.","security":[{"Bearer":[]}],"parameters":[{"name":"emailID","in":"query","description":"Filter to list device mappings using the email address of a user.","required":false,"schema":{"type":"string"}},{"name":"deviceIdentifierType","in":"query","description":"Filter to list device mappings using the unique device identifier type of the device.(serial-number, uuid, or hostname).","required":false,"schema":{"type":"string","enum":["serial-number","uuid","hostname"]}},{"name":"deviceIdentifier","in":"query","description":"Specify the unique id of the device for the selected deviceIdentifierType in inSync.","required":false,"schema":{"type":"string"}},{"name":"restoreData","in":"query","description":"Filter to list device mappings using the type of data restore performed","required":false,"schema":{"type":"string","enum":["All","Data","System"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceMappingList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devicemappings/{mappingID}":{"delete":{"tags":["Endpoints"],"summary":"Delete device mapping","description":"Permanently deletes a user-to-device mapping created for mass deployment.","security":[{"Bearer":[]}],"parameters":[{"name":"mappingID","in":"path","description":"The id associated with the device mapping. Get the mapping id by running the List Device Mapping API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK. The device mapping is deleted successfully.","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devices/{deviceID}/decommission":{"post":{"tags":["Endpoints"],"summary":"Decommission a device","description":"Decommission the device. Decommissioning a laptop or desktop allows you to securely wipe out data from all folders that inSync protects, which includes backup folders and inSync Share data. This is helpful in scenarios where devices are stolen or lost and you want to wipe out critical data from a device.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"path","description":"The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/devices/{deviceID}/upgradeClient":{"post":{"tags":["Endpoints"],"summary":"Upgrade inSync Client on a device","description":"Upgrade inSync Client to its latest version on a user device. The inSync Client is upgraded only if a higher version is available.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"path","description":"The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"The request was well-formed but was not processed due to semantic errors."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/backups":{"get":{"tags":["Endpoints"],"summary":"List endpoint backups","description":"Returns the details of last successful backups on user devices for the last 30 days.","security":[{"Bearer":[]}],"parameters":[{"name":"lastSuccessful","in":"query","required":true,"description":"Provides details of the last successful backup for a device. \n Currently, only 'True' is the supported value for this parameter.","schema":{"type":"boolean","enum":["true"]}},{"name":"deviceID","in":"query","description":"Filter to get list of last successful backups for a particular device using its unique ID. Get the ID of a device using the ‘List all devices’ API. ","required":false,"schema":{"type":"integer"}},{"name":"userID","in":"query","description":"Filter to get list of last successful backups on devices owned by a particular user using their user ID. Get the ID of a user using the ‘List all users’ API.","required":false,"schema":{"type":"integer"}},{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}},{"name":"minBackupStartTime","in":"query","description":"Filter to list successful backups that started after a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"maxBackupStartTime","in":"query","description":"Filter to list successful backups that started before a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"minBackupEndTime","in":"query","description":"Filter to list successful backups that ended after a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"maxBackupEndTime","in":"query","description":"Filter to list successful backups that ended before a particular date and time. Format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/restores":{"get":{"tags":["Endpoints"],"summary":"List all restore activities","description":"Returns the list of all the restore activities performed on user devices with their details.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"query","description":"Specify the device ID to get a filtered list of restore activities performed from a device. \n Get the device ID by using the ‘List all devices’ API.","required":false,"schema":{"type":"integer"}},{"name":"targetDeviceID","in":"query","description":"Specify the device ID to get a filtered list of restore activities performed on that device. \n Get the target device ID by using the ‘List all devices’ API.","required":false,"schema":{"type":"integer"}},{"name":"userID","in":"query","description":"Specify the user ID to filter and get the list of restore activities performed by a user. You can get the user ID by using the ‘List all users’ API.","required":false,"schema":{"type":"integer"}},{"name":"minStartTime","in":"query","description":"Specify the start date and start time to get the list of restore activities performed after the specified start date and time. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ \nExample: 2019-10-04T11:03:27Z","required":false,"schema":{"type":"string"}},{"name":"maxStartTime","in":"query","description":"Specify the start date and start time to get the list of restore activities performed before the specified start date and time. The format for this parameter value is YYYY-MM-DDTHH:MM:SSZ \nExample: 2019-10-04T11:03:27Z","required":false,"schema":{"type":"string"}},{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Endpoints"],"summary":"Initiate a restore activity","description":"Creates a restore request. You can either restore data of users on the same device from which it was backed up or to their other devices registered with inSync. \nYou can restore the data ONLY from the most recent snapshot to the target device. \nYou can initiate multiple restore activities. Multiple restore activities may be consolidated into a single activity based on inSync Client version and appropriate status is displayed for each activity. ","security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["deviceID","targetDeviceID","restoreLocation"],"properties":{"deviceID":{"description":"Specify the unique ID of the device in inSync from which you want to initiate the restore activity.\nGet the ID of the device using the ‘List all devices’ API.","type":"integer","example":1234},"targetDeviceID":{"description":"Specify the target device ID to which you intend to restore the data.\nThe target device must belong to the same user.\nGet the target device ID by using the ‘List all devices’ API.\nTarget device ID can be same in case you are restoring the data on the same device.","type":"integer","example":242},"restoreLocation":{"description":"Specify the location to which you intend to restore the data on the selected device.\n Specify one of the following - \n1) Desktop - If you want to restore the data to the desktop on the target device. \n2) Original - If you want to restore data to the same location from which it was backed up. \n3) If you want to restore the data at a custom location, specify absolute path of the location. Example - /home/jeremy/statusReport","type":"string","example":"Original"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRestores"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"422":{"description":"Unprocessable entity. \n Example - It is the latest un-quarantined snapshot and can't be deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v1/restores/{restoreID}":{"get":{"tags":["Endpoints"],"summary":"Get restore by restoreID","description":"Returns the restore activity details based on the restore ID.","security":[{"Bearer":[]}],"parameters":[{"name":"restoreID","in":"path","description":"Specify the unique ID of the restore activity. You can get the restore ID by using the ‘List all restore activities’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Restore"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v2/devices":{"get":{"tags":["Endpoints"],"summary":"List all devices - v2","description":"Returns information about all the user devices protected using Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"userID","in":"query","description":"Specify the user ID to get a list of devices associated with a single user. Get the ID of a user using the 'List all users' API.","required":false,"schema":{"type":"integer"}},{"name":"userIDs","in":"query","description":"Specify the user IDs, separated by commas, to get a list of devices associated with multiple users. Get the user IDs using the 'List all users' API.","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"deviceIDs","in":"query","description":"Filter the list of devices by specifying only the required device IDs, separated by commas. Get the device IDs by using this ‘List all devices’ API.","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"profileIDs","in":"query","description":"Specify the profile IDs, separated by commas, to get a list of devices associated with multiple profiles. Get the ID of a profile using the ‘List all profiles’ API.","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"searchPrefixDeviceName","in":"query","description":"Specify the prefix from the device name by which you intend to search and list the devices. Example - “My” is the prefix in the device name “MyDevice123”.","required":false,"schema":{"type":"string"}},{"name":"clientVersion","in":"query","description":"Filter the list of devices by the inSync Client version installed on it. Example - 6.2.0","required":false,"schema":{"type":"string"}},{"name":"platformOS","in":"query","required":false,"description":"Filter the list of devices by specifying the operating system of the device.","schema":{"type":"string","enum":["win32","linux2","darwin","android","ios"]}},{"name":"deviceStatus","in":"query","required":false,"description":"Filter the list by specifying the status of the device.","schema":{"type":"string","enum":["enabled","disabled"]}},{"name":"upgradeState","in":"query","required":false,"description":"The upgrade state of the device.","schema":{"type":"string","enum":["NOT UPGRADABLE","UPGRADABLE","UPTODATE","SCHEDULED","UNKNOWN"]}},{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}},{"name":"minLastConnected","in":"query","description":"Filter to list devices that are connected to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"maxLastConnected","in":"query","description":"Filter to list devices that are connected to Druva inSync before a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"minAddedOn","in":"query","description":"Filter to list devices that are added to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"maxAddedOn","in":"query","description":"Filter to list devices that are added to Druva inSync after a particular date. Example format - YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"serialNumber","in":"query","description":"Get device information using the unique serial number assigned to an individual piece of hardware by the manufacturer.","required":false,"schema":{"type":"string"}},{"name":"uuid","in":"query","description":"Get device information using the unique 128-bit number UUID used to identify device on internet.","required":false,"schema":{"type":"string"}},{"name":"deviceMarkedInactive","in":"query","description":"Filter the list of devices that are marked as inactive. For example, if you select true, all devices that are marked as inactive are listed. For more information about inactive devices, see <a href=https://docs.druva.com/Endpoints/030_Set_up_inSync_for_Endpoints/010_Initial_Configuration/030_Create_and_manage_profiles/010_Create_a_profile>Create Profile</a>.","required":false,"schema":{"type":"boolean","enum":["true","false"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceListV2"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/endpoints/v2/devices/{deviceID}":{"get":{"tags":["Endpoints"],"summary":"Get device information - v2","description":"Returns device information using deviceID.","security":[{"Bearer":[]}],"parameters":[{"name":"deviceID","in":"path","description":"The unique ID of device in inSync. Get the ID of a device using the ‘List all devices’ API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceV2"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/storagemanagement/v1/storages":{"get":{"tags":["Storage Management"],"summary":"List all storages","description":"Returns the list of all the storages configured for your account in Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/storagemanagement/v1/storages/{storageID}":{"get":{"tags":["Storage Management"],"summary":"Get storage information","description":"Returns information about a particular storage using storageID.","security":[{"Bearer":[]}],"parameters":[{"name":"storageID","in":"path","description":"Specify the unique storage ID to get its detailed information. Get the ID of a storage using the 'List all storages' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Storage"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/storagemanagement/v1/cloudcaches":{"get":{"tags":["Storage Management"],"summary":"List all CloudCache Servers","description":"Returns the list of CloudCache Servers configured in Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudCacheList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/storagemanagement/v1/cloudcaches/{cloudCacheID}":{"get":{"tags":["Storage Management"],"summary":"Get CloudCache Server information","description":"Returns information about a particular CloudCache Server using storageID.","security":[{"Bearer":[]}],"parameters":[{"name":"cloudCacheID","in":"path","description":"Specify the unique CloudCache Server ID to get its detailed information. Get the ID of a storage using the 'List all CloudCache Servers' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudCache"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/eventmanagement/v2/events":{"get":{"tags":["Event Management"],"summary":"List all events","description":"Returns the list of all the events generated in Druva inSync. You can also get Events API response in CEF and Syslog formats. For more information, see <a href=https://developer.druva.com/docs/event-apis>Events API to export inSync events.</a>","security":[{"Bearer":[]}],"parameters":[{"name":"tracker","in":"query","required":false,"description":"Each Events API request returns a response that contains a maximum of 500 inSync events. If there are more than 500 events, the response also contains a Tracker, an identifier that contains inSync database reference and identifies the next set of unique events when a successive Events API call is made.\nTracker is valid for the next 48 hours after a response is generated.\nYou must include the Tracker in your subsequent request to fetch the next unique list of inSync events. Do not include the Tracker in the first Events API request.\n:fa-info-circle:If you do not specify the Tracker in the successive request, inSync returns you the same list of events in response that you received in the first Event API request.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/legalholds/v3/policies":{"get":{"tags":["Legal Hold"],"summary":"List legal hold policies - v3","description":"Returns a list of all the Legal Hold policies that are configured in Druva inSync.","security":[{"Bearer":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLegalholds"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}},"post":{"tags":["Legal Hold"],"summary":"Create a legal hold policy - v3","description":"Creates a legal hold policy in Druva inSync.","security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestCreateLHPolicy"}}},"description":"Request body to create legal hold policy."},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCreateLHPolicy"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_422"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v3/policies/{policyId}":{"get":{"tags":["Legal Hold"],"summary":"Get details of a legal hold policy - v3","description":"Returns details of a legal hold policy configured in Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","description":"Specify the unique ID of the legal hold policy to get its details. Get the ID of a legal hold policy using the 'List legal hold policies' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetLegalholds"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}},"delete":{"tags":["Legal Hold"],"summary":"Delete a legal hold policy - v3","description":"Deletes the legal hold policy from Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","description":"Specify the unique ID of the legal hold policy to be deleted. Get the ID of a legal hold policy using the 'List legal hold policies' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteLegalholds"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v3/policies/{policyId}/users":{"post":{"tags":["Legal Hold"],"summary":"Add or delete users (custodians) from a legal hold policy - v3","description":"Add or delete users from a legal hold policy in Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","description":"Specify the unique ID of the legal hold policy from which you want to add OR delete the custodians.","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestOperateOnCustodians"}}},"description":"Request body to add OR delete users from the legal hold policy."},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseOperateOncustodians"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}},"get":{"tags":["Legal Hold"],"summary":"List the users on legal hold - v3","description":"Returns the list of users who are on legal hold in Druva inSync.","security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","description":"Specify the unique ID of the legal hold policy for which you want the list of users. Get the ID of a legal hold policy using the 'List legal hold policies' API.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGetCustodians"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v3/users/policies":{"post":{"tags":["Legal Hold"],"summary":"List legal hold policies associated with a user - v3","description":"Returns the list of legal hold policies that are associated with a user.","security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestListPoliciesByUsers"}}},"description":"Request body to add OR delete users from the legal hold policy."},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListPoliciesByUsers"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/policies":{"get":{"tags":["Legal Hold"],"description":"Returns a list of all the Legal Hold policies that are configured in Druva inSync.","summary":"List Legal Hold policies - v4","operationId":"PoliciesGet","deprecated":false,"security":[{"Bearer":[]}],"parameters":[{"name":"sortBy","in":"query","description":"Sort Legal Hold policies by using one of the following options.","schema":{"type":"string","enum":["createdOn","name"]}},{"name":"sortOrder","in":"query","description":"Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"custodians","in":"query","description":"Specify the Custodian email IDs separated by comma. Example - John.Doe@druva.com","schema":{"type":"string"}},{"name":"legalHoldTypes","in":"query","description":"Specify the Legal Hold type. Select a predefined type from the available options or a custom type as per your need.","schema":{"type":"string","enum":["Human Resources","Information Security","Legal"]}},{"name":"searchString","in":"query","description":"Search by Legal Hold name. Example - Jan_2021","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLegalHoldPolicies"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_422"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}},"post":{"tags":["Legal Hold"],"description":"Creates a Legal Hold policy in Druva inSync.","summary":"Create a Legal Hold policy - v4","operationId":"PoliciesPost","deprecated":false,"security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLegalHoldPolicyRequest"}}},"description":"Request body to create legal hold policy.","required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLegalHoldPolicyResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_422"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/policies/{policyId}":{"get":{"tags":["Legal Hold"],"description":"Returns the details of a Legal Hold policy using policyID.","summary":"Legal Hold policy details - v4","operationId":"GetLegalHoldDetails","deprecated":false,"security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","required":true,"description":"Unique ID of the Legal Hold policy. Example - 4","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalHoldPolicy"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_422"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}},"delete":{"tags":["Legal Hold"],"summary":"Delete a Legal Hold policy - v4","description":"Deletes the Legal Hold policy from inSync Cloud.","security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","description":"Specify the unique ID of the Legal Hold policy to be deleted. Get the ID of a Legal Hold policy using the 'List Legal Hold policies' API. Example - 12529","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeleteLegalholds"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"404":{"description":"Not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_422"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/policies/{policyId}/users":{"get":{"tags":["Legal Hold"],"description":"Returns the list of users who are a part of Legal Hold.","summary":"Lists the users of a Legal Hold policy - v4","deprecated":false,"security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","required":true,"description":"Specify the unique ID of the Legal Hold policy for which you want the list of users. Get the ID of a Legal Hold policy using the 'List Legal Hold policies' API. Example - 12529","schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Search users according to the page number. Example-1.","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Search users according to the page size. The maximum page size should not exceed 500. Example - 100.","schema":{"type":"integer"}},{"name":"searchPrefix","in":"query","description":"Search users by user name or user's email. Example - john.doe@druva.com","schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Sort to filter the list of users. You can sort the users by user name.","schema":{"type":"string","enum":["name"]}},{"name":"sortOrder","in":"query","description":"Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewLegalHoldPolicyCustodians"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_422"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/policies/{policyId}/collection-stream":{"get":{"tags":["Legal Hold"],"description":"Returns the list of all Legal Hold devices.","summary":"Lists all the devices of a Legal Hold policy - v4","deprecated":false,"security":[{"Bearer":[]}],"parameters":[{"name":"policyId","in":"path","required":true,"description":"Specify the unique ID of the Legal Hold policy for which you want the list of devices. Get the ID of a Legal Hold policy using the 'List Legal Hold policies' API. Example - 12529","schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Search the list of devices on Legal Hold according to the page number. Default value - 1 Example - 10.","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Search the list of devices on Legal Hold according to their page size. The maximum page size should not exceed 500. The minimum page size should be greater than or equal to 1. Example: 100.","schema":{"type":"integer"}},{"name":"searchString","in":"query","description":"Search the list of devices on Legal Hold according to the device name. Example - DESKTOP1-device.","schema":{"type":"string"}},{"name":"collectionType","in":"query","description":"Filter the list of devices on Legal Hold according to device type. Example - Backup.","schema":{"type":"string","enum":["Backup","Additional"]}},{"name":"collectionStatus","in":"query","description":"Filter the list of devices on Legal Hold according to device collection status. Example - Failed.","schema":{"type":"string","enum":["Successful","Failed","Collected with Errors","Never Collected","Collection Throttled","Inactive"]}},{"name":"sortBy","in":"query","description":"Sort to filter the list of devices on Legal Hold. Example - custodianName.","schema":{"type":"string","enum":["custodianName","deviceName","totalCollectedData","lastCompletedCollection","deviceStatus"]}},{"name":"sortOrder","in":"query","description":"Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.","schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewLegalHoldPolicyCollectionStream"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_422"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/clients":{"get":{"tags":["Legal Hold"],"description":"Returns a list of all the eDiscovery Download Clients that are configured in inSync.","summary":"List eDiscovery Download Clients - v4","operationId":"ClientsGet","deprecated":false,"security":[{"Bearer":[]}],"parameters":[{"name":"sortBy","in":"query","description":"Key to sort the results. You can sort by: name/clientVersion/cplatform/createdBy","schema":{"type":"string","enum":["name","clientVersion","cplatform","createdBy"]}},{"name":"sortOrder","in":"query","description":"Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"connectionStatus","in":"query","description":"The connection status of the client. It can be 'Connected', 'Disconnected', or 'Not Registered'.","schema":{"type":"string","enum":["Connected","Disconnected","Not Registered"]}},{"name":"searchBy","in":"query","description":"Search by the name of the eDiscovery Download Client. Example - Client1","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Search by Page Number. Example - 1","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Search by Page Size. Example - 100","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClients"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/clients/{clientId}":{"get":{"tags":["Legal Hold"],"description":"Returns details of a eDiscovery Download Client.","summary":"Get eDiscovery Download Client details - v4","operationId":"getClient","security":[{"Bearer":[]}],"parameters":[{"in":"path","name":"clientId","description":"Client ID for which details are to be fetched. Example - 54.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Details of the client requested.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client_details"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/job/{jobId}":{"get":{"tags":["Legal Hold"],"description":"Returns the details of the eDiscovery Download Client job.","summary":"Get details of a download job - v4","operationId":"GetDetailsOfJob","deprecated":false,"security":[{"Bearer":[]}],"parameters":[{"name":"jobId","in":"path","required":true,"description":"Specify the unique ID of the download job. Get the ID of a job using the 'List eDisovery Download Client jobs' API.","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDetails"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_404"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/job":{"post":{"tags":["Legal Hold"],"description":"Download custodian data from inSync using the eDiscovery Download Client.","summary":"Initiate custodian data download - v4","operationId":"createNewJob","deprecated":false,"security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDownloadJobRequest"}}},"description":"Request body to initiate the custodian data download.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDownloadJobResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}},"put":{"tags":["Legal Hold"],"description":"Use this API to cancel, retry, pause, and resume download jobs.","summary":"Manage eDiscovery Download Client jobs - v4","operationId":"takeActionOnJob","deprecated":false,"security":[{"Bearer":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TakeActionOnJobRequest"}}},"description":"Request body to take action on the job.","required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TakeActionOnJobResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_401"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/legalholds/v4/jobs":{"get":{"tags":["Legal Hold"],"description":"List all download jobs triggered with eDisocvery Download Clients.","summary":"List all download jobs - v4","operationId":"GetCustomerJobs","deprecated":false,"security":[{"Bearer":[]}],"parameters":[{"name":"sortBy","in":"query","description":"Sort the list of results. You can sort by: jobId/jobStartTime/custodian/dataDownloaded/legalholdName/jobStatus/dataSource","schema":{"type":"string","enum":["jobId","jobStartTime","custodian","dataDownloaded","legalholdName","jobStatus","dataSource"]}},{"name":"sortOrder","in":"query","description":"Specify the parameter by which you intend to sort the listed results. Sorting can be done in ascending or descending order.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"jobStartTime","in":"query","description":"The time when the job was triggered. Example - 1625154576","schema":{"type":"integer"}},{"name":"searchBy","in":"query","description":"Search by data source name. Example - DRUVA6598","schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Search by Page Number. Example - 1","schema":{"type":"integer"}},{"name":"pageSize","in":"query","description":"Search by Page Size. Example - 100","schema":{"type":"integer"}},{"name":"jobStatus","in":"query","description":"Filter jobs based on their status. Example - [Queued,Paused,Running,Cancelled,Successful,Failed,Completed with Errors]","schema":{"type":"string","enum":["Queued","Paused","Running","Cancelled","Successful","Failed","Completed with Errors"]}},{"name":"custodian","in":"query","description":"Name of custodians. Example - John Doe. \n\nNote: You can use either the 'custodian' or 'custodianList' parameter to filter by custodians, but they cannot be used simultaneously.","schema":{"type":"string"}},{"name":"custodianList","in":"query","description":"List of custodian names. Example - [\"John Doe\",\"Jane Smith\",\"Smith,John\",\"Alice Johnson\"]. \n\nNote: You can use either the 'custodian' or 'custodianList' parameter to filter by custodians, but they cannot be used simultaneously.","schema":{"type":"string"}},{"name":"legalholdName","in":"query","description":"Search by legal hold name. Example - Feb_2021.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListJobsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_400"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_500"}}}}}}},"/admanagement/v1/adConnectors":{"get":{"tags":["AD/LDAP Management"],"summary":"List all AD/LDAP Connectors","description":"Returns a list of all AD/LDAP Connectors configured in Druva Console with their details.","security":[{"Bearer":[]}],"parameters":[{"name":"status","in":"query","description":"Specify the status to filter and list AD/LDAP Connectors with the selected status.\n- connected - To filter and list AD/LDAP Connectors which are connected to Druva Cloud.\n- not connected - To filter and list AD/LDAP Connector which are not connected to Druva Cloud.","required":false,"schema":{"type":"string","enum":["connected","not connected"]}},{"name":"pageToken","in":"query","description":"The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ADConnectorList"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"403":{"description":"The request was not processed due to insufficient permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP_403"}}}},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/audittrailmanagement/v1/auditTrailSettings":{"get":{"tags":["Audit Trail Management"],"summary":"Get admin audit trail retention settings","description":"Preserving Audit Trails is useful for governance and compliance purposes in a business. This API returns the duration that your Druva Cloud Administrator has configured to retain the Administrator Audit Trails.","security":[{"Bearer":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditTrailRetentionSettings"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or an expired authentication token was supplied."},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in inSync GovCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"501":{"description":"Requested HTTP method is not implemented.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"servers":[{"url":"https://govcloudapis.druva.com/insync"}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apis.druva.com/token","scopes":{"read":"Grants read access"}}}},"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"User":{"type":"object","properties":{"userID":{"type":"integer","format":"int64","description":"The unique id of the user in inSync. Example - 1","example":1},"userName":{"type":"string","description":"The username of the user in inSync. Example - Ernie Carter","example":"Ernie Carter"},"emailID":{"type":"string","description":"The email address of the user. Example - ernie.carter@druva.com","example":"ernie.carter@druva.com"},"status":{"type":"string","description":"The status of the user account. Example - active","enum":["active","preserved"]},"profileID":{"type":"integer","description":"The profile ID of the profile associated with the user. Example - 1","example":1},"storageID":{"type":"integer","description":"The storage ID of the storage associated with the user. Example - 1","example":1},"cacheID":{"type":"integer","description":"The CloudCache Server ID associated with the user. Example - 1","example":1},"quota":{"type":"string","description":"The storage quota assigned to the user in inSync. Example - 10 GB","example":"10 GB"},"quotaInBytes":{"type":"integer","description":"The storage quota assigned to the user (in bytes) in inSync. Example - 10737418240","example":10737418240},"addedOn":{"type":"string","format":"date-time","description":"The date on which the user was added in inSync. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"privacySettingsEnabled":{"type":"string","description":"Displays the status of the privacy setting of the user. If the value returned is True, privacy setting is enabled by the user. If the value returned is False, privacy settings is not set or user has allowed admin access to their data.","example":true},"ldapGUID":{"type":"boolean","format":"hexstring","description":"The AD or LDAP object GUID of the user in a hex string format. Example: B1C47201C67910458867BA19982E353E. The ldapGUID displays objectGUID if the user is imported from AD and displays entryUUID if imported from LDAP.","example":"B1C47201C67910458867BA19982E353E"}}},"UserCreate":{"type":"object","properties":{"userID":{"type":"integer","format":"int64","description":"The unique id of the user in Druva inSync. Example - 1","example":1},"userName":{"type":"string","description":"The user name of the user in Druva inSync. Example - Ernie Carter","example":"Ernie Carter"},"emailID":{"type":"string","description":"The email address of the user. Example - ernie.carter@druva.com","example":"ernie.carter@druva.com"},"status":{"type":"string","description":"The status of the user account. Example - active","enum":["active","preserved"]},"profileID":{"type":"integer","description":"The profile ID of the profile associated with the user. Example - 1","example":1},"storageID":{"type":"integer","description":"The storage ID of the storage associated with the user. Example - 1","example":1},"quota":{"type":"string","description":"The storage quota assigned to the user in inSync. Example - 50 GB","example":"50 GB"},"quotaInBytes":{"type":"integer","description":"The storage quota (in bytes) assigned to the user in inSync. Example - 53687091200","example":53687091200},"addedOn":{"type":"string","format":"date-time","description":"The date on which the user was added in inSync. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"}}},"UserList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The total number of users listed in the result pages.","example":1},"nextPageToken":{"type":"string","description":"The token to access the next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"Profile":{"type":"object","properties":{"profileID":{"type":"integer","format":"int64","description":"The unique id of the profile in inSync. Example - 1","example":1},"profileName":{"type":"string","description":"The name assigned to the profile in inSync. Example - Default","example":"profile1"},"profileDescription":{"type":"string","description":"Description of the profile. Example - Default profile with pre-configured values","example":"dummy"},"notifyNoSync":{"type":"integer","format":"int64","description":"Number of days of backup inactivity after which an alert notification is triggered","example":7}}},"ProfileList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The number of profiles listed in the result pages.","example":1},"nextPageToken":{"type":"string","description":"The token to access next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"profiles":{"type":"array","items":{"$ref":"#/components/schemas/Profile"}}}},"Device":{"type":"object","properties":{"deviceID":{"type":"integer","format":"int64","description":"The unique id of the device in inSync. Example - 12345","example":12345},"deviceName":{"type":"string","description":"The device name in inSync. Example - Ernie Carter's Macbook","example":"Ernie Carter's Macbook"},"serialNumber":{"type":"string","description":"A unique, identifying number assigned to an individual piece of hardware by the manufacturer. Example - PX045","example":"PX045"},"deviceOS":{"type":"string","description":"The operating system of the device. Example - Mojave","example":"mojave"},"deviceOSVersion":{"type":"string","description":"The version of the operating system of the device. Example - 10.14 r34567","example":"10.14 r34567"},"platformOS":{"type":"string","description":"The operating system platform of the device. Example - darwin","example":"darwin","enum":["win32","linux2","darwin","android","ios"]},"uuid":{"type":"string","description":"A 128-bit number used to uniquely identify device in internet. Example - TY5h67-5674r-675645","example":"TY5h67-5674r-675645"},"clientVersion":{"type":"string","description":"The inSync Client version installed on the device. Example - 6.1.0 r56746","example":"6.1.0 r56746"},"deviceStatus":{"type":"string","description":"The status of the device. Example - enabled","enum":["enabled","disabled"]},"upgradeState":{"type":"string","description":"The upgrade state of the device.","enum":["NOT UPGRADABLE","UPGRADABLE","UPTODATE","SCHEDULED","UNKNOWN"]},"userID":{"type":"integer","description":"A unique id of the user in inSync.","example":1},"totalBackupData":{"type":"string","description":"The storage quota consumed by the user.","example":"40.05 GB"},"totalBackupDataInBytes":{"type":"integer","description":"The storage quota consumed by the user (in bytes).","example":43003360051},"addedOn":{"type":"string","format":"date-time","description":"The date and time on which the device was added to inSync. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"lastUpgradedOn":{"type":"string","format":"date-time","description":"The date on which the inSync Client was last updated for the user. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"lastConnected":{"type":"string","format":"date-time","description":"The date and time on which the inSync Client last connected with inSync GovCloud. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"deviceMarkedInactive":{"type":"boolean","description":"Devices marked as inactive. Example - true","example":true}}},"DeviceV2":{"type":"object","properties":{"deviceID":{"type":"integer","format":"int64","description":"The unique id of the device in inSync. Example - 12345","example":12345},"deviceName":{"type":"string","description":"The device name in inSync. Example - Ernie Carter's Macbook","example":"Ernie Carter's Macbook"},"serialNumber":{"type":"string","description":"A unique, identifying number assigned to an individual piece of hardware by the manufacturer. Example - PX045","example":"PX045"},"deviceOS":{"type":"string","description":"The operating system of the device. Example - Mojave","example":"mojave"},"deviceOSVersion":{"type":"string","description":"The version of the operating system of the device. Example - 10.14 r34567","example":"10.14 r34567"},"platformOS":{"type":"string","description":"The operating system platform of the device. Example - darwin","example":"darwin","enum":["win32","linux2","darwin","android","ios"]},"uuid":{"type":"string","description":"A 128-bit number used to uniquely identify device in internet. Example - TY5h67-5674r-675645","example":"TY5h67-5674r-675645"},"clientVersion":{"type":"string","description":"The inSync Client version installed on the device. Example - 6.1.0 r56746","example":"6.1.0 r56746"},"deviceStatus":{"type":"string","description":"The status of the device. Example - enabled","enum":["enabled","disabled"]},"upgradeState":{"type":"string","description":"The upgrade state of the device.","enum":["NOT UPGRADABLE","UPGRADABLE","UPTODATE","SCHEDULED","UNKNOWN"]},"userID":{"type":"integer","description":"A unique id of the user in inSync.","example":1},"totalBackupData":{"type":"string","description":"The storage quota consumed by the user.","example":"40.05 GB"},"totalBackupDataInBytes":{"type":"integer","description":"The storage quota consumed by the user (in bytes).","example":43003360051},"addedOn":{"type":"string","format":"date-time","description":"The date and time on which the device was added to inSync. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"lastUpgradedOn":{"type":"string","format":"date-time","description":"The date on which the inSync Client was last updated for the user. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"lastConnected":{"type":"string","format":"date-time","description":"The date and time on which the inSync Client last connected with inSync GovCloud. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"deviceMarkedInactive":{"type":"boolean","description":"Devices marked as inactive. Example - true","example":true},"disabledMode":{"type":"string","description":"The mode via which the device was disabled. Example - Manual","example":"Manual","enum":["Manual","API","User Preserved","Decommission"]},"disabledOn":{"type":"string","format":"date-time","description":"The date and time when the device was disabled. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"}}},"DeviceList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The total number of devices listed in the result pages.","example":1},"nextPageToken":{"type":"string","description":"The token to access next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"devices":{"type":"array","items":{"$ref":"#/components/schemas/Device"}}}},"DeviceListV2":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The total number of devices listed in the result pages.","example":1},"nextPageToken":{"type":"string","description":"The token to access next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"devices":{"type":"array","items":{"$ref":"#/components/schemas/DeviceV2"}}}},"DeviceMappingCreate":{"type":"object","properties":{"mappingID":{"type":"string","description":"The id of the device mapping in inSync. Example - 3452rw6","example":"3452rw6"},"emailID":{"type":"string","description":"The email address of the user. Example - ernie.carter@druva.com","example":"ernie.carter@druva.com"},"userName":{"type":"string","description":"The username of the user in inSync. Example - Ernie Carter","example":"Ernie Carter"},"deviceName":{"type":"string","description":"The device name linked to the user in inSync.","example":"Ernie Carter's Macbook"},"deviceIdentifierType":{"type":"string","description":"The unique id type of the device in inSync. Example - Serial Number","example":"Serial Number"},"deviceIdentifier":{"type":"string","description":"The unique id of the device in inSync. Example - Po3XF ","example":"Po3XF"},"oldDeviceName":{"type":"string","description":"The old device name linked to the user in inSync. Example - Ernie Carter's Old Macbook","example":"Ernie Carter's Old Macbook"},"restoreData":{"type":"string","description":"The type of data restore performed on the new device. Example - SYSTEM","example":"SYSTEM"}}},"DeviceMappingList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The total number of device mappings listed on the result page. Example - 3","example":1},"nextPageToken":{"type":"string","description":"The token to access next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"imdMappings":{"type":"array","items":{"$ref":"#/components/schemas/DeviceMappingCreate"}}}},"Backup":{"type":"object","properties":{"deviceID":{"type":"integer","format":"int64","description":"It is unique postive integer id associated with device.","example":12345},"backupStatus":{"type":"string","description":"Backup status of the device","enum":["Completed"]},"filesBackedUp":{"type":"integer","description":"The number of files backed up in the last successful backup.","example":124},"bytesTransferred":{"type":"integer","description":"The number of bytes transferred in the last successful backup.","example":23456},"filesMissed":{"type":"integer","description":"The number of files missed on the device in the last successful backup.","example":50},"snapshotSize":{"type":"string","description":"The size of the snapshot generated in the last successful backup in MBs.","example":"2546 MB"},"startTime":{"type":"string","format":"date-time","description":"The start time of the last successful backup. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the last successful backup. Example - 2019-10-25T00:00:00Z","example":"2019-10-25T00:00:00Z"},"systemSettingsBackedUp":{"type":"boolean","description":"Specifies whether the system settings were backed up as part of the backup."}}},"BackupList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","example":1},"nextPageToken":{"type":"string","description":"The token to access next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"backups":{"type":"array","items":{"$ref":"#/components/schemas/Backup"}}}},"Restore":{"type":"object","properties":{"deviceID":{"type":"integer","description":"The unique ID of the device from which the restore activity was triggered. Example: 12345"},"targetDeviceID":{"type":"integer","description":"The device ID of the device to which the data was restored. Example: 12345"},"restoreLocation":{"type":"string","description":"The location on the device to which the data was restored. \nThe possibles locations are:\n 1) Original: If the data was restored to the original location\n 2) Desktop: If the data was restored to desktop\n 3)Custom location: If data was restored to a custom location\n 4) Unknown: If the restore was performed from a mobile device to a mobile device."},"userID":{"type":"integer","description":"The unique ID of the user who triggered the restore activity. Example: 12345"},"restoreID":{"type":"integer","description":"The unique ID of the restore activity. This value is 'null' in case of restore was initiated from a mobile device. Example: 12345"},"startTime":{"type":"string","format":"date-time","description":"The start time of the restore activity. \nExample: 2013-04-17T09:12:36Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the restore activity. Example: 2013-04-17T09:13:36Z. This value is empty if the restore activity is ongoing."},"status":{"type":"string","description":"Status of the restore activity. It is:\n 1) Successful: If the restore activity was completed successfully.\n 2) Ongoing: If the restore activity is ongoing. \n 3) Failed: If the restore activity was failed.\n4) Cancelled: If the restore activity was cancelled manually.\n 5) Completed with Errors: If some files were missed during the restore activity."},"restoreSize":{"type":"string","description":"The size of the data restored. Example: 285 MB \n This value is 'Unknown' for restores that failed to start. "},"numberOfFilesRestored":{"type":"integer","description":"The total number of files that were restored in the restore activity. Example: 456"},"numberOfFilesMissed":{"type":"integer","description":"The total number of files that were missed from the restore activity. Example: 12 \n This value is 'null' if the restore activity is ongoing."},"restoreMode":{"type":"string","description":"The persona who initiated the restore. Personas are: \nSelf: inSync user himself \nAdmin: Administrator."},"systemSettingsRestore":{"type":"boolean","description":"This returns 'true' if system setting were restored else returns 'false'."},"failureReason":{"type":"string","description":"This returns the failure reason if the status is 'failed' else returns 'empty.","example":""}}},"RestoreDefault":{"type":"object","properties":{"deviceID":{"type":"integer","description":"The unique ID of the device in inSync from which the restore activity was triggered. Example: 12345","default":null,"example":12345},"targetDeviceID":{"type":"integer","description":"The unique ID of the device in inSync to which the data was restored.\nIt can be similar to 'deviceID' if the data was restored on the same device. Example: 12345.","default":null,"example":12345},"restoreLocation":{"type":"string","description":"Displays the location at which the data was restored. Example - Original.\nPossible values are - \n1) Desktop - If the data was restored on the user desktop. \n2) Original - If the data was restored to the original location from where it was backed up. \n3) Absolute path of the location on the device if the data was restored at a custom location.","default":"","example":"Desktop"},"userID":{"type":"integer","description":"The unique ID of the user in inSync for whom the restore activity was triggered. Example: 12345","default":null,"example":12345},"restoreID":{"type":"integer","description":"The unique ID of the restore activity. Example: 12345. \nThis value is 'null' in case the restore was initiated from a mobile device. ","default":null,"example":12345},"startTime":{"type":"string","format":"date-time","description":"The start time of the restore activity. Example - 2013-04-17T09:12:36Z","default":"","example":"2019-11-19T06:49:15Z"},"endTime":{"type":"string","format":"date-time","description":"The end time of the restore activity. No value is displayed for this field as it is an ongoing restore activity.","default":"","example":""},"status":{"type":"string","description":" The status of the restore activity. Always displays 'Ongoing' as the restore activity is in progress","default":"Ongoing","example":"Ongoing"},"restoreSize":{"type":"string","description":"The size of data restored. No value is displayed for this field as it is an ongoing restore activity.","default":"","example":""},"numberOfFilesRestored":{"type":"integer","description":"The number of files restored in the restore activity. 'Null' is displayed for this field as it is an ongoing restore activity..","default":null,"example":null},"numberOfFilesMissed":{"type":"integer","description":"The number of files missed during the restore activity. 'Null' is displayed for this field as it is an ongoing restore activity.","default":null,"example":null},"restoreMode":{"type":"string","description":"Information of the restore initiator. Always displays 'Admin' as the initiator of the restore activity.","default":"Admin","example":"Admin"},"systemSettingsRestore":{"type":"boolean","description":" Displays whether system settings are restored as part of restore. 'Null' is displayed for this field as it is an ongoing restore activity.","default":null,"example":null},"failureReason":{"type":"string","description":"Displays the reason for failure if the restore activity has failed, else the value is empty.","default":"","example":""}}},"RestoreList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The total number of restore activities listed in the result pages. Example: 4096"},"nextPageToken":{"type":"string","description":"The token to access the next page of results. This parameter will be empty for the last page of results."},"restores":{"type":"array","items":{"$ref":"#/components/schemas/Restore"}}}},"CreateRestores":{"type":"object","properties":{"restores":{"type":"array","items":{"$ref":"#/components/schemas/RestoreDefault"}},"totalSize":{"type":"integer","format":"int64","description":"The total number of restore activities created.","example":1}}},"Storage":{"type":"object","properties":{"StorageID":{"type":"integer","format":"int64","description":"The unique identifier of the storage in Druva inSync.","example":1},"storageName":{"type":"string","description":"The name of the storage in Druva inSync.","example":"Druva3_local"},"storageUsage":{"type":"string","description":"The storage space consumed on the storage.","example":"225.04 MB"},"totalSizeOfBackedUpFiles":{"type":"string","description":"The total size of the files backed up on this storage.","example":"1.29 GB"}}},"StorageList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The number of storage listed in the result pages.","example":1},"nextPageToken":{"type":"string","description":"The token to access next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"storages":{"type":"array","items":{"$ref":"#/components/schemas/Storage"}}}},"CloudCache":{"type":"object","properties":{"cloudCacheID":{"type":"integer","format":"int64","description":"The inSync assigned unique identifier of the CloudCache Server.","example":1},"cloudCacheName":{"type":"string","description":"The name of the CloudCache Server.","example":"Druva_cloudcache"},"status":{"type":"string","description":"The current status of the CloudCache Server.","enum":["Not Active","Active","Decommissioned"],"example":"Active"},"cacheUsage":{"type":"string","description":"The total disk space that the cache data consumed until date.","example":"1.29 GB"},"totalCacheSize":{"type":"string","description":"The total disk space available for cache data.","example":"1 TB"}}},"CloudCacheList":{"type":"object","properties":{"totalSize":{"type":"integer","format":"int64","description":"The number of CloudCache Servers listed on the result pages.","example":1},"nextPageToken":{"type":"string","description":"The token to access next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"cloudcaches":{"type":"array","items":{"$ref":"#/components/schemas/CloudCache"}}}},"Event":{"type":"object","properties":{"eventID":{"type":"integer","format":"int64","description":"The unique id of the event in inSync.","example":101},"initiator":{"type":"string","description":"The initiator of the event. In case of a user generated event or an administrator generated event the corresponding email address is displayed. In case of System event, the initiator will always be the name of the system.","example":"ernie.carter@druva.com"},"inSyncDataSourceID":{"type":"integer","description":"The inSync assigned identifier of the user device on which the event occurred.","example":2},"inSyncDataSourceName":{"type":"string","description":"The device name on which the event occurred.","example":"DDSPL1111"},"clientVersion":{"type":"string","description":"The inSync Client version on the user device.","example":"6.1.1r73332"},"clientOS":{"type":"string","description":"The OS on which the inSync Client is installed.","example":"win32"},"inSyncUserID":{"type":"integer","description":"inSync assigned identifier of the user associated with the event.","example":11},"inSyncUserName":{"type":"string","description":"The name of the inSync user associated with the event.","example":"sagard"},"inSyncUserEmail":{"type":"string","description":"The email of the inSync user associated with the event.","example":"ernie.carter@druva.org"},"profileID":{"type":"integer","description":"inSync assigned identifier of the inSync profile to which the user, associated with the occurred event is linked to.","example":3},"profileName":{"type":"string","description":"The name of the inSync profile to which the user, associated with the occurred event is linked to.","example":"document_desktop_profile"},"eventType":{"type":"string","description":"Type of Event, <a href=https://developer.druva.com/docs/event-apis> List of Supported events</a>","example":"API Login"},"eventState":{"type":"string","description":"State of Event","example":"Success"},"eventDetails":{"type":"string","description":"Details about event specific to event. Also has eventgroupID which is userful for correlation of multiple events of single activity. if it is a backup event, details such as number of files backed up, number of files missed, time for backup, and so on.","example":"Total Backup Size:0, Files Backed up:0, Files Missed:0, System and App Settings:Yes, Total Bytes Transferred:0, eventsGroupId:2"},"timeStamp":{"type":"string","description":"The date and time when the event was generated. Format - YYYY-MM-DDTHH:MM:SSZ \n Example - 2019-10-25T00:00:00Z","example":"2019-05-28T07:07:00Z"},"severity":{"type":"string","description":"The severity level of the event as defined in Druva inSync.","example":6},"ip":{"type":"string","description":"The IP address of the device on which the event occurred. In case of an admin event, IP address of the device on which the administrator logged on to perform inSync activity is displayed.","example":"114.143.238.10"},"facility":{"type":"string","description":"The facility number as defined in inSync Management Console Events API settings. Default value is 23.","example":23}}},"EventList":{"type":"object","properties":{"tracker":{"type":"string","description":"Tracker is valid for the next 48 hours after a response is generated. \n:fa-info-circle: Include the Tracker in your subsequent request to fetch the next unique list of inSync events.","example":"MTExMQ=="},"nextPageExists":{"type":"boolean","description":"The flag to know if next page of result exists.","example":true},"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}}},"Error":{"type":"object","properties":{"code":{"type":"string","example":"InsyncEndpoints-1006","description":"Application specific error code"},"message":{"type":"string","example":"Internal server error","description":"Application specific error message"},"retryable":{"type":"boolean","default":false,"description":"If true, retry using exponential backoff"},"data":{"type":"object","description":"Dictionary of values present in the error message for localization. Currently, no values are available."}}},"ListLegalholds":{"type":"object","properties":{"legalholdList":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The data access type of the legal hold policy","enum":["All Backup Data","Last Backup Data","Data within a Date Range"],"example":"Data within a Date Range"},"name":{"type":"string","description":"The name of the legal hold policy","example":"LH Policy 1"},"policyId":{"type":"integer","description":"The ID of the legal hold policy","example":"1"},"cullingType":{"type":"string","description":"The filter type of the legal hold policy. \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","enum":["Include All Files","Include Only Deleted Files"],"example":"Include Only Deleted Files"},"startDate":{"type":"string","description":"The start date in the range in which the data is to be accessed. Format: YYYY-MM-DD \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","format":"date","example":"2019-03-19"},"endDate":{"type":"string","description":"The end date in the range in which the data is to be accessed. Format: YYYY-MM-DD \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","format":"date","example":"2019-10-25"}}}}}},"GetLegalholds":{"type":"object","properties":{"type":{"type":"string","description":"The data access type of the legal hold policy","enum":["All Backup Data","Last Backup Data","Data within a Date Range"],"example":"Data within a Date Range"},"name":{"type":"string","description":"The name of the legal hold policy","example":"LH Policy 1"},"policyId":{"type":"integer","description":"The ID of the Legal hold policy","example":"1"},"cullingType":{"type":"string","description":"The filter type of the legal hold policy. \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","enum":["Include All Files","Include Only Deleted Files"],"example":"Include Only Deleted Files"},"startDate":{"type":"string","description":"The start date in the range in which the data is to be accessed. Format: YYYY-MM-DD \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","format":"date","example":"2019-03-19"},"endDate":{"type":"string","description":"The end date in the range in which the data is to be accessed. Format: YYYY-MM-DD \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","format":"date","example":"2019-10-25"}}},"RequestCreateLHPolicy":{"type":"object","properties":{"name":{"type":"string","description":"The name of the legal hold policy. Example - Legal Hold Policy 1","example":"LH Policy 1"},"type":{"type":"string","description":"The data access type of the legal hold policy","enum":["All Backup Data","Last Backup Data","Data within a Date Range"],"example":"Data within a Date Range"},"cullingType":{"type":"string","description":"The filter type of the legal hold policy. \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'. Use any of the filter types","enum":["Include All Files","Include Only Deleted Files"]},"startDate":{"type":"string","description":"The start date in the range in which the data is to be accessed. Format: YYYY-MM-DD \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","format":"date","example":"2019-03-19"},"endDate":{"type":"string","description":"The end date in the range in which the data is to be accessed. Format: YYYY-MM-DD \n :fa-info-circle: Applicable only if the data access type is 'Data within a Date Range'.","format":"date","example":"2019-10-25"}}},"ResponseCreateLHPolicy":{"type":"object","properties":{"policyId":{"type":"integer","description":"The ID of the legal hold policy. Example - 1","example":"1"}}},"DeleteLegalholds":{"type":"object","properties":{}},"RequestOperateOnCustodians":{"type":"object","properties":{"custodians":{"type":"array","items":{"type":"object","properties":{"emailId":{"type":"string","description":"The email address of the user, who should be added to OR deleted from the legal hold policy.","example":"john.doe@someorg.com"}}}},"action":{"type":"string","description":"The action to be performed on the user.","enum":["add","delete"],"example":"add"}}},"ResponseOperateOncustodians":{"type":"object","properties":{"alreadyOnLegalhold":{"type":"array","description":"While adding a user to a legal hold policy, if a user is already on legal hold then the email address is returned in this list. This field is returned only if the action is 'add'.","items":{"type":"object","properties":{"emailId":{"type":"string","description":"Email address of users which are already on legal hold.","example":"john.doe@someorg.com"}}}},"notOnLegalhold":{"type":"array","description":"While deleting a user from a legal hold policy, if a user is already deleted from legal hold then the user email address will be returned in this list. This field is returned only if the action is 'delete'.","items":{"type":"object","properties":{"emailId":{"type":"string","description":"Email address of users which are already deleted from legal hold or are not on legal hold.","example":"john.doe_1@someorg.com"}}}},"notInsyncUsers":{"type":"array","items":{"type":"object","description":"While adding OR deleting a user from a legal hold policy, if the user is not a valid inSync user then the user email address will be returned in this list.","properties":{"emailId":{"type":"string","description":"Email address of users which are not valid inSync users.","example":"john.doe_2@someorg.com"}}}}}},"ResponseGetCustodians":{"type":"object","properties":{"custodians":{"type":"array","items":{"type":"object","properties":{"emailId":{"type":"string","description":"Email address of the users associated with the legal hold policy. Example - ernie.carter@druva.com","example":"john.doe@someorg.com"},"webdavUrl":{"type":"string","description":"WebDAV URL to access the user's data.","example":"https://restore-c1-kunals.drtst.in/webdav/LH Policy 1/uname/"}}}}}},"RequestListPoliciesByUsers":{"type":"object","properties":{"custodians":{"type":"array","items":{"type":"object","properties":{"emailId":{"type":"string","description":"Email address of the user for which the associated legal hold policies are requested. Example - ernie.carter@druva.com","example":"john.doe@someorg.com"}}}},"action":{"type":"string","enum":["list"]}}},"ResponseListPoliciesByUsers":{"type":"object","properties":{"custodians":{"type":"array","items":{"type":"object","properties":{"emailId":{"type":"string","description":"Email address of the user for which the associated legal hold policies are requested. Example - ernie.carter@druva.com","example":"john.doe@someorg.com"},"policyIds":{"type":"array","items":{"type":"integer","description":"The list of legal hold policy ids associated with the user. Example - 2,4,11","example":"2, 4, 11"}}}}}}},"HTTP_400":{"type":"object","properties":{"code":{"type":"integer","enum":["inSyncLegalholds-4294967489"],"example":"inSyncLegalholds-4294967489"},"message":{"type":"string","enum":["Invalid API Syntax"],"example":"Invalid API Syntax"},"data":{"type":"object"},"retryable":{"type":"boolean","enum":[false,true]}}},"HTTP_401":{"type":"object","properties":{"code":{"type":"string","enum":["inSyncLegalholds-4294967557","inSyncLegalholds-4294967391"],"example":"inSyncLegalholds-4294967391"},"message":{"type":"string","example":"Authentication/Authorization failed"},"data":{"type":"object"},"retryable":{"type":"boolean","enum":[false,true],"example":false}}},"HTTP_403":{"type":"object","properties":{"code":{"type":"string","example":"InsyncAdmanagement-1221","description":"Application specific error code"},"message":{"type":"string","example":"Access restricted due to insufficient permissions.","description":"Application specific error message"},"retryable":{"type":"boolean","example":false,"description":"If true, retry using exponential backoff"},"data":{"type":"object","description":"Dictionary of values present in the error message for localization. Currently, no values are available."}}},"HTTP_404":{"type":"object","properties":{"code":{"type":"string","enum":["inSyncLegalholds-4294967438"],"example":"inSyncLegalholds-4294967438"},"message":{"type":"string","enum":["Legalhold policy not found."],"example":"Legalhold policy not found."},"data":{"type":"object"},"retryable":{"type":"boolean","enum":[false,true],"example":false}}},"HTTP_422":{"type":"object","properties":{"code":{"type":"integer","enum":["inSyncLegalholds-4294967423"]},"message":{"type":"string"},"data":{"type":"object"},"retryable":{"type":"boolean","enum":["false","true"]}}},"HTTP_500":{"type":"object","properties":{"code":{"type":"string","enum":["inSyncLegalholds-2003"],"example":"inSyncLegalholds-2003"},"message":{"type":"string","example":"Programing Error occurred on server, please check server logs for more details"},"data":{"type":"object"},"retryable":{"type":"boolean","enum":[false,true],"example":false}}},"ListLegalHoldPolicies":{"title":"ListLegalHoldPolicies","type":"object","properties":{"results":{"$ref":"#/components/schemas/ListingData"}}},"ListingData":{"title":"ListingData","type":"object","properties":{"legalHoldsList":{"type":"array","items":{"$ref":"#/components/schemas/LegalHoldDetails"}}}},"LegalHoldDetails":{"title":"LegalHoldDetails","type":"object","properties":{"startDate":{"type":"string","description":"Start time if webdav access type selected is Data within a Date Range. Example- Apr 11 2021","format":"mmm DD YYYY","example":"Apr 11 2021"},"endDate":{"type":"string","description":"End time if webdav access type selected is Data within a Date Range. Example- Jun 12 2021","format":"mmm DD YYYY","example":"Jun 12 2021"},"webDavAccessType":{"type":"string","description":"Type of webdav access. Example- 'All Collected Data' OR 'Last Collected Data' OR 'Data within a Date Range'","enum":["All Collected Data","Last Collected Data","Data within a Data Range"],"example":"All Collected Data"},"isADCEnabled":{"type":"boolean","description":"Flag to indicate if Additional Data Collection is enabled. Example - true/false.","enum":["true","false"],"example":"true"},"createdOn":{"type":"string","description":"Date and Time when Legal Hold Policy was created. Example- 'Jul 01 2021, 08:54'","example":"Jul 01 2021, 08:54"},"legalHoldType":{"type":"string","description":"Type of Legal Hold Policy. Example- Human Resources","example":"Human Resources"},"policyId":{"type":"integer","format":"int32","description":"Unique ID of the Legal Hold policy. Example - 20","example":20},"createdBy":{"type":"string","description":"Name of admin creating Legal Hold Policy. Example - Ernie Carter","example":"Ernie Carter"},"numberOfCustodians":{"type":"integer","format":"int32","description":"Count of Custodians in the Legal Hold Policy. Example - 7","example":7},"legalHoldTypeId":{"type":"integer","format":"int32","description":"Unique ID of the legal hold type. Example - 132","example":132},"deletedFilesOnly":{"type":"boolean","description":"Use true if you want to access only deleted files. Otherwise, use false.","enum":[true,false],"example":false},"name":{"type":"string","description":"Name of the Legal Hold policy. Example - Jan_2021","example":"Jan_2021"}}},"CreateLegalHoldPolicyRequest":{"title":"CreateLegalHoldPolicyRequest","type":"object","properties":{"name":{"type":"string","description":"Name of Legal Hold policy to be created. Example - Feb_2021.","example":"Feb_2021"},"legalHoldType":{"type":"string","description":"Type of Legal Hold to be created. \n This parameter is optional. \n If not specified it is set to '--'. Example- Human Resources.","example":"Human Resources"},"webDavAccessType":{"type":"string","description":"The data access type of the legal hold policy. Use any of the following: ","enum":["All Collected Data","Last Collected Data","Data within a Date Range"],"example":"Data within a Date Range"},"startDate":{"type":"string","description":"The start date in the range in which the data is to be accessed if webdav access type selected is 'Data within a Date Range'. \n This parameter is optional if webdav access type is not 'Data within a Date Range'. Example - Apr 11 2021","format":"mmm DD YYYY","example":"Apr 11 2021"},"endDate":{"type":"string","description":"The end date in the range in which the data is to be accessed if webdav access type selected is 'Data within a Date Range'. \n This parameter is optional if webdav access type is not 'Data within a Date Range'. Example - May 11 2021","format":"mmm DD YYYY","example":"May 11 2021"},"deletedFilesOnly":{"type":"boolean","description":"Use 'true' if you want to access only deleted files. Otherwise, use 'false'. \n This parameter is optional.","enum":[true,false],"example":"false"},"isADCEnabled":{"type":"boolean","description":"Use 'true' if you want to enable Additional Data Collection for this Legal Hold. Otherwise, use 'false'. \n This parameter is optional.","enum":[true,false],"example":"true"},"collectionFrequency":{"type":"string","description":"Choose collection frequency of additional data collection from one of the following option. To use this parameter isADCEnabled should be set to true. \n This parameter is optional.","enum":["One time","Recurring"],"example":"Recurring"},"accessBackupData":{"type":"boolean","description":"Use 'true' if you want to enable Backup Data Access for this Legal Hold policy. The accessBackupData and accessAdditionalData parameters cannot be set to false simultaneously. The default value is set to 'true'.","example":true},"accessAdditionalData":{"type":"boolean","description":"Use 'true' if you want to enable Additional Data Collection access for this Legal Hold policy. The isADCEnabled value must be set to 'true' to enable this option. The default value is set to 'false'.","example":false}},"required":["name","webDavAccessType","startDate","endDate"]},"CreateLegalHoldPolicyResponse":{"title":"CreateLegalHoldPolicyResponse","type":"object","properties":{"policyId":{"type":"integer","description":"The unique ID of the created Legal Hold policy. Example - 12359","example":12359}}},"LegalHoldPolicy":{"title":"LegalHoldPolicy","type":"object","properties":{"results":{"type":"object","properties":{"legalHoldPolicy":{"type":"object","properties":{"startDate":{"type":"string","description":"Start time if webdav access type selected is 'Data within a Date Range'. Example- Apr 11 2021","format":"mmm DD YYYY","example":"Apr 11 2021"},"webDavAccessUrls":{"type":"array","items":{"type":"string"},"description":"URL for accessing webDav. Example - ['https://restore-c22-cloud.druva.com/webdav/Mike']","example":"['https://restore-c22-cloud.druva.com/webdav/Mike']"},"endDate":{"type":"string","description":"End time if webdav access type selected is 'Data within a Date Range'. Example- Jun 12 2021","format":"mmm DD YYYY","example":"Jun 12 2021"},"webDavAccessType":{"type":"object","additionalProperties":{"type":"string"},"description":"Type of Webdav access. Example- 'All Collected Data' OR 'Last Collected Data' OR 'Data within a Date Range'","enum":["All Collected Data","Last Collected Data","Data within a Date Range"],"example":"Data within a Date Range"},"isADCEnabled":{"type":"boolean","description":"Flag to indicate if ADC feature is enable for Legal Hold policy or not. Example-true/false","enum":[true,false],"example":"false"},"directDownLoadLink":{"type":"string","description":"URL for direct download Legalhold Policy of a user. Example-'https://downloads.druva.com/insync/webdav/1-2/'","example":"https://downloads.druva.com/insync/webdav/1-2/"},"createdOn":{"type":"string","description":"Date and Time when Legal Hold Policy was created. Example- 'Feb 24 2021, 08:54'","example":"Feb 24 2021, 08:54"},"usersCount":{"type":"integer","format":"int32","description":"Count of custodians on Legal Hold. Example -5","example":5},"accessAdditionalData":{"type":"boolean","description":"Flag to indicate additional data access for Legal Hold policy. Example-true/false","enum":[true,false],"example":"false"},"legalHoldType":{"type":"string","description":"Type of Legal Hold policy created. It can be custom or pre-defined. Example- Human Resources","example":"Human Resources"},"webDavAuthentication":{"type":"string","description":"webDAV authentication is done using inSync Administrator credential.","example":"Use your inSync Administrator credential"},"accessBackupData":{"type":"boolean","description":"Flag to indicate backup data access for Legal Hold policy. Example-true/false","enum":[true,false],"example":"true"},"policyId":{"type":"integer","format":"int32","description":"Unique ID of the Legal Hold policy. Example - 4","example":4},"createdBy":{"type":"string","description":"Name of the admin who created the Legal Hold policy. Example - Ernie Carter","example":"Ernie Carter"},"legalHoldTypeId":{"type":"integer","format":"int32","description":"Legal Hold policy type Id. Example - 1397","example":1397},"collectionFrequency":{"type":"string","description":"Backup data collection frequency. Example - Not collecting/One time/Recurring.","enum":["Not collecting","One time","Recurring"],"example":"Not collecting"},"deletedFilesOnly":{"type":"boolean","description":"Use 'true' if you want to access only deleted files of users who are on this Legal Hold policy. Otherwise use 'false'.","enum":[true,false],"example":"true"},"name":{"type":"string","description":"Name of Legal Hold policy. Example - Jan_2021","example":"Jan_2021"}}}}}}},"ViewLegalHoldPolicyCollectionStream":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/ViewLegalHoldPolicyCollectionStreamResponse"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}},"ViewLegalHoldPolicyCollectionStreamResponse":{"type":"object","properties":{"streamsList":{"$ref":"#/components/schemas/StreamList"},"totalResults":{"type":"integer","format":"int32","description":"Number of devices in a given Legal Hold policy. Example- 4","example":1}}},"StreamList":{"type":"array","items":{"properties":{"deviceName":{"type":"string","description":"Name of the device that is on Legal Hold. Example - Desktop1-john","example":"Desktop1-john"},"collectionType":{"type":"string","description":"The type of the device. It can be either Backup or Additional.","enum":["Backup","Additional"],"example":"Backup"},"collectionStatus":{"type":"string","description":"Collection status of a device on Legal Hold. Example - Successful","enum":["Successful","Failed","Collected with Errors","Never Collected","Collection Throttled","Inactive"],"example":"Successful"},"totalCollectedDataInBytes":{"type":"integer","format":"int32","description":"Size of the total data (in bytes) collected. Example - 1800010372","example":1800010372},"linkId":{"type":"integer","format":"int32","description":"For device type 'Additional', this is the ID of the linked backup device. Example - 10008179","example":10008179},"custodianName":{"type":"string","description":"Name of the custodian on Legal Hold. Example - John Doe","example":"John Doe"},"platformIcon":{"type":"string","description":"Name of the device platform image. Example - windows.png","example":"windows.png"},"deviceStatus":{"type":"string","description":"Status of the device. Example - Enabled","example":"Enabled"},"isCollectionDisabled":{"type":"boolean","description":"Flag to indicate if collection on Legal Hold is disabled or not. Example - false","example":false},"isCloudApp":{"type":"boolean","description":"Flag to indicate if the device on Legal Hold is of type Cloud Apps. Example - false","example":false},"custodianId":{"type":"integer","format":"int32","description":"Unique ID of the custodian. Example - 10005623","example":10005623},"deviceId":{"type":"integer","format":"int32","description":"Unique ID of the device. Example - 10008211","example":10008211},"lastCompletedCollection":{"type":"string","description":"Timestamp of last completed collection for a device. Example - Sep 05 2024, 02:55","example":"Sep 05 2024, 02:55"},"platformName":{"type":"string","description":"Name of the device platform. Example - win32","example":"win32"},"totalCollectedData":{"type":"string","description":"Total data collected. Example - 2.12 GB","example":"2.12 GB"}}}},"ViewLegalHoldPolicyCustodians":{"type":"object","properties":{"results":{"$ref":"#/components/schemas/ViewLegalHoldPolicyCustodiansResponse"},"pageInfo":{"$ref":"#/components/schemas/PageInfo"}}},"ViewLegalHoldPolicyCustodiansResponse":{"type":"object","properties":{"usersList":{"$ref":"#/components/schemas/UsersList"},"totalCustodians":{"type":"integer","format":"int32","description":"Number of custodians in a Legal Hold policy. Example- 1","example":1}}},"PageInfo":{"type":"object","properties":{"totalPages":{"type":"integer","description":"Total number of pages for the API Response. Example - 1","example":1},"pageNumber":{"type":"integer","format":"int32","description":"Page number for which API response is expected. Example - 1","example":1},"pageSize":{"type":"integer","description":"Page Size for API response. Example - 100","example":100}}},"UsersList":{"type":"array","items":{"properties":{"userName":{"type":"string","description":"Name of the user who is on Legal Hold. Example - John Doe","example":"John Doe"},"status":{"type":"string","description":"The status of the user. It can be either Active or Inactive.","enum":["Active","Inactive"],"example":"Active"},"userEmail":{"type":"string","description":"User email ID who is on Legal Hold. Example - john@druva.org","example":"john@druva.org"},"collectedData":{"type":"string","description":"Size of the data collected in the last backup snapshot. Example - 1.68 GB","example":"1.68 GB"},"collectedDataInBytes":{"type":"integer","description":"Size of the data (in bytes) collected in the last backup snapshot. Example - 1800010372","example":1800010372},"userId":{"type":"integer","format":"int32","description":"Unique ID of the user. Example - 3","example":3},"policyId":{"type":"integer","format":"int32","description":"Unique ID of the Legal Hold policy to which the user belongs. Example - 12529","example":12529},"onLegalHold":{"type":"boolean","description":"Flag to indicate if user is on Legal Hold or not. Example - true/false","example":true},"numberOfDataSources":{"type":"integer","description":"Number of data sources for current User. Example - 2","example":2},"totalCollectedData":{"type":"string","description":"Total data collected. Example - 2.12 GB","example":"2.12 GB"},"totalCollectedDataInBytes":{"type":"integer","description":"Total data collected in bytes. Example - 2276332666","example":"2276332666"}}}},"ListClients":{"title":"ListClients","type":"object","properties":{"totalPages":{"type":"integer","description":"Total number of pages for the API Response. Example - 1","example":1},"totalResults":{"type":"integer","description":"Total number of results. Example - 1","example":1},"clients":{"allOf":[{"type":"array","items":{"$ref":"#/components/schemas/Client_details"}}]},"pageNumber":{"type":"integer","description":"Page number for which API response is expected. Example - 1","example":1},"pageSize":{"type":"integer","description":"Page Size for API response. Example - 100","example":100}}},"Client_details":{"title":"Client_details","properties":{"ddClientHostName":{"type":"string","description":"The name of the device where the client is installed. Example - John-8765-Windows-PC","example":"John-8765-Windows-PC"},"clientSecretId":{"type":"string","description":"API secret part of API credentials. Example - E1AMfwKbQUXGY6sbPB9igPyDL3CbhyWa","example":"E1AMfwKbQUXGY6sbPB9igPyDL3CbhyWa"},"client_features":{"type":"object","properties":{"metadata_download":{"type":"boolean","enum":[true,false],"example":true},"zip_download":{"type":"boolean","enum":[true,false],"example":true},"data_download":{"type":"boolean","enum":[true,false],"example":true},"integrity_check":{"type":"boolean","enum":[true,false],"example":true}},"description":"A dictionary containing information about the features that the client support."},"cplatform":{"type":"string","description":"The operating system of the device where the client is installed. Example - win32","example":"win32"},"name":{"type":"string","description":"Name of the eDiscovery Download Client machine. Example - client1_PF_123","example":"client1_PF_123"},"clientVersion":{"type":"string","description":"Version of the eDiscovery Download Client. Example - 1.1.1","example":"1.1.1"},"ip":{"type":"string","description":"IP address of the eDiscovery Download Client machine. Example - 110.11.14.10","example":"110.11.14.10"},"clientId":{"type":"integer","description":"Client ID part of API credentials. Example-59","example":59},"connectionStatus":{"type":"string","description":"Connection status of the eDiscovery Download Client. There can be the following statuses:","enum":["Not Registered","Connected","Disconnected"],"example":"Connected"},"createdBy":{"type":"string","description":"Name of admin who created the eDiscovery Download Client. Example - John Doe","example":"John Doe"},"defaultDownloadLocation":{"type":"string","description":"Default download location for eDiscovery download. Example - 'D:\\Data'","example":"D:\\Data"},"activationTime":{"type":"integer","description":"Timestamp when the eDiscovery Download Client machine was activated. Example - 1624887294","example":1624887294}}},"JobDetails":{"title":"JobDetails","type":"object","properties":{"dataDownload":{"type":"integer","description":"Flag to download data. Use 1 as the value if you want to download the data.","enum":[0,1],"example":"1"},"custodianEmail":{"type":"string","description":"The email address of the custodian. Example - john@druva.org","example":"john@druva.org"},"jobId":{"type":"integer","description":"Unique Id of the job. Example - 55","example":55},"addWebdavProp":{"type":"string","description":"WebDAV property."},"percentComplete":{"type":"integer","description":"Percentage of data that has been downloaded. Example - 100","example":100},"webdavUrl":{"type":"string","description":"WebDAV access URL","example":"https://restore-c1-druva.com/webdav/legal-policy1/John/OneDrive/"},"jobEndTime":{"type":"integer","description":"TimeStamp when the job ended. Example - 1597914384","example":1597914384},"clientSecretId":{"type":"string","description":"Client secret Id. Example - jEpceguNqE98heUe7rboMh9kkahXWyW","example":"jEpceguNqE98heUe7rboMh9kkahXWyW"},"legalholdId":{"type":"integer","description":"Unique ID of the Legal Hold policy. Example - 47","example":47},"metadataDownload":{"type":"integer","description":"Flag to indicate if metadata option is selected for the download.","enum":[0,1],"example":1},"ddClientId":{"type":"integer","description":"The unique ID of the eDiscovery Download Client. Example - 48","example":48},"totalFiles":{"type":"integer","description":"Total number of files available for download. Example - 10","example":10},"data_integrity":{"type":"integer","description":"Data integrity. Example - 10","example":10},"type_name":{"type":"string","description":"Legal Hold type name. Example - Human Resources","example":"Human Resources"},"jobStatus":{"type":"string","description":"Status of the job. Example - '[Queued,Paused,Running,Cancelled,Successful,Failed,Completed with Errors]'","enum":["Queued","Paused","Running","Cancelled","Successful","Failed","Completed with Errors"],"example":"Successful"},"dataDownloaded":{"type":"integer","description":"Size of the downloaded data. Example - 5731256","example":5731256},"legalholdName":{"type":"string","description":"Name of Legal Hold Policy for which download is triggered. Example - Legal-Policy1","example":"Legal-Policy1"},"jobStartTime":{"type":"integer","description":"Timestamp when job was triggered in epoch. Example - 1597909321","example":1597909321},"totalDataSize":{"type":"integer","description":"Size of the data that is to be downloaded. Example - 5731256","example":5731256},"cplatform":{"type":"string","description":"The operating system where the eDiscovery Download Client is installed. Example - win32","example":"win32"},"dCategory":{"type":"string","description":"Category of device. Example - cloudapp-others","example":"cloudapp-others"},"custodian":{"type":"string","description":"Name of the custodian whose data is being downloaded. Example - John Doe","example":"John Doe"},"errorMessage":{"type":"string","description":"Error message if download fails. Example - ERR_401","example":"ERR_401"},"filesDownloaded":{"type":"integer","description":"Count of files that were downloaded. Example - 10","example":10},"dataSource":{"type":"string","description":"Name of the data source from where the data will be downloaded. Example - OneDrive","example":"OneDrive"},"createdBy":{"type":"string","description":"Name of the inSync administrator who is initiating the download. Example - Ernie Carter","example":"Ernie Carter"},"totalFilesZipped":{"type":"integer","description":"Total files that are zipped. Example - 15","example":15},"downloadLocation":{"type":"string","description":"Download location of data to be downloaded. Example - D:\\Downloads","example":"D:\\Downloads"},"data_integrity_enabled":{"type":"integer","description":"Data integrity flag is enabled. Example - 1","example":1},"downloadOption":{"type":"integer","description":"0 indicates only metadata, 1 indicates data and metadata and 2 indicates zip download option.","enum":[0,1,2],"example":1},"total_data_integrity":{"type":"integer","description":"Total data integrity count. Example - 131","example":131},"customerId":{"type":"integer","description":"Unique ID of the customer. Example - 7","example":7},"clientName":{"type":"string","description":"Name of the eDiscovery Download Client. Example - Client-1.0.0","example":"Client-1.0.0"}}},"CreateDownloadJobRequest":{"title":"JobDetails","type":"object","properties":{"clientName":{"type":"string","description":"Name of the eDiscovery Download Client. Example - Client1","example":"Client1"},"downloadOption":{"type":"integer","description":"0 indicates only metadata, 1 indicates data and metadata and 2 indicates zip download option.","enum":[0,1,2],"example":2},"legalholdId":{"type":"integer","description":"Legal Hold ID for which download is to be triggered. Example -10","example":10},"downloadLocation":{"type":"string","description":"Location to download the job. Example - D:\\Downloads","example":"D:\\Downloads"},"createdBy":{"type":"string","description":"Name of admin triggering the job. Example - Ernie Carter","example":"Ernie Carter"},"custodianEmails":{"allOf":[{"type":"array","items":{"type":"string","description":"userEmail for which data is to be downloaded.","example":"john.doe@druva.com"}}]},"enable_data_integrity":{"type":"boolean","description":"Use true if data integrity is to be enabled else false.","enum":[true,false],"example":false}},"required":["clientName","downloadOption","legalholdId","downloadLocation","createdBy","custodianEmails","enable_data_integrity"]},"CreateDownloadJobResponse":{"title":"CreateDownloadJobResponse","type":"object","properties":{"message":{"type":"string","example":"Download initiated. Click Download Jobs on the left pane to view details."}}},"TakeActionOnJobRequest":{"title":"TakeActionOnJobRequest","type":"object","properties":{"jobIds":{"type":"array","items":{"type":"integer"},"description":"List of Job IDs for which action is to be taken. Example-[115,114]","example":"[115,114]"},"action":{"type":"string","description":"Specify the action that you want to take. Use any of the following: ","enum":["Cancel","Pause","Retry","Resume"],"example":"Cancel"}},"required":["action","jobIds"]},"TakeActionOnJobResponse":{"title":"TakeActionOnJobResponse","type":"object","properties":{"message":{"type":"string","example":"Download Job has been Cancelled Successfully."},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/JobDetails"}}}},"ListJobsResponse":{"allOf":[{"title":"ListJobsResponse","type":"object","properties":{"totalPages":{"type":"integer","description":"Total number of pages for the API Response. Example - 10","example":10},"pageNumber":{"type":"integer","description":"Page Number for which API response is expected. Example - 1","example":1},"totalResults":{"type":"integer","description":"Total number of jobs. Example - 4","example":4},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/JobDetails"}},"pageSize":{"type":"integer","description":"Page Size for API response. Example - 100","example":100}}}]},"ADConnector":{"type":"object","properties":{"id":{"type":"integer","description":"The unique ID of the AD/LDAP Connector in Druva Cloud.","example":"1"},"name":{"type":"string","description":"The name of the AD/LDAP Connector configured in the Druva Console.","example":"AD_Conn_1"},"lastConnectedTime":{"type":"integer","description":"The date and time when the AD/LDAP Connector to Druva Cloud. \n:fa-info-circle: The date and time is displayed in Unix epoch time. Kindly convert as appropriate for further consumption.","example":"1665038000"},"lastStatusChange":{"type":"integer","description":"The date and time when the AD/LDAP Connector status changed from 'Connected' to 'Not Connected' or vice versa. \n:fa-info-circle: The date and time is displayed in Unix epoch time. Kindly convert as appropriate for further consumption.","example":"1665038043"},"status":{"type":"string","description":"The current status of the AD/LDAP Connector","example":"Connected"}}},"ADConnectorList":{"type":"object","properties":{"total":{"type":"integer","format":"int64","description":"The total number of AD/LDAP Connectors listed on the result page.","example":1},"nextPageToken":{"type":"string","description":"The token to access the next page of results. This parameter will be empty for the last page of results.","example":"MTExMQ=="},"adConnectorList":{"type":"array","items":{"$ref":"#/components/schemas/ADConnector"}}}},"AuditTrailRetentionSettings":{"type":"object","properties":{"adminAuditTrailRetentionPolicy":{"type":"integer","description":"The Audit Trail Retention settings in the duration of seconds. Example - 2592000 \n Here are the observed values and translation in days/months/year. \n- 2592000 → 30 days\n- 7776000 → 3 months\n- 15552000 → 6 months\n- 31536000 → 1 year \n- -1 → Ever","example":"2592000"}}}}}}