Skip to main content

 

Druva Documentation

List of Report APIs

inSync Cloud Editions: File:/tick.png Elite Plus File:/tick.png Elite File:/cross.png Enterprise File:/cross.png Business

Overview

This topic provides you information on the available Report APIs in read-only mode. When you fetch information using Report APIs, information is retrieved with following conventions:

  • All size related attributes like quota consumed, data usage, and so on are displayed in MB.
  • All dates are in mm/dd/yy hh:mm format.

List of Report APIs

Here's the list of APIs that you can use:

User List API

 
  • Description - Retrieves information for all users in inSync.
  • Request: GET /api/reports/v1/users HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"Profile":"default"}...]}

Following table lists the attributes that are fetched when you use the User List API.

Attribute Description
user_name The name of the user.
email_id The email address of the user.
added_on The date and time when the user was added.
profile The profile that is assigned to the user.
total_usage The amount of space consumed by the user in MB.
user_status The status of the user. For example, enabled.
allocated_quota The quota (amount of space) allocated to the user in MB.
storage The name of the storage on which the user data is stored.

Device List API

 
  • Description - Retrieves information on all the devices running inSync.
  • Request: GET /api/reports/v1/devices HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"first_backup_size": "1029.46"}...]}

Following table lists the attributes that are fetched when you use the Device List API.

Attribute Description
email_id The email address of the user.
device_name The name of the device that is registered to the user.
device_status The status of the device. For example, activated.
clientOS The operating system of the user's device.
added_on The date and time when the device was added.
first_backup_status The status of the first backup operation.
total_backup_data The total size of backed up data for the device in MB. Total size is a combination of incremental and differential backup data for the device.
first_backup_size The size of backed up data on first backup for the device in MB.
system_settings_backed_up The status of whether the device's system settings were backed up.

Last Backup Details API

 
  • Description - Retrieves last backup information for each device in inSync.
  • Request: GET /api/reports/v1/lastbackupdetails HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"backup_start_time": "01/20/16 19:12"}...]} 

Following table lists the attributes that are fetched when you use the Last Backup Details List API.

Attribute Description
email_id The email address of the user.
device_name The name of the device on which backup occurred.
last_backup_status The status of the backup operation.
bytes_transferred The number of bytes transferred during backup.
backup_data The size of the files in MB that were backed up during the last backup operation.
files_missed The number of files missed in last backup.
files_backed_up The number of files that are backed up.
system_settings_backed_up The status of whether the device's system settings were backed up.
backup_start_time The date and time when backup started.
backup_end_time The date and time when backup completed.

First Backup Details API

 
  • Description - Retrieves first backup information for each device in inSync.
  • Request: GET /api/reports/v1/firstbackupdetails HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"system_settings_backed_up": "Not Backed Up"}...]}

Following table lists the attributes that are fetched when you use the First Backup Details API.

Attribute Description
email_id The email address of the user.
device_name The name of the device on which backup occurred.
first_backup_status The first backup status of the device.
first_backup_size The first backup size of the device.
system_settings_backed_up The status of whether the device's system settings were backed up.
time_taken The time taken for the first backup to complete.

Share Details API

 

Note:You must have inSync Share enabled to use this API.

  • Description - Retrieves information on usage of inSync Share by each user in inSync.
  • Request: GET /api/reports/v1/sharedetails HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"email_id": "ernie.carter@druva.com"}...]}

Following table lists the attributes that are fetched when you use the Share Details API.

Attribute Description
email_id The email address of the user.
total_files The total number of files that are shared by the user.
shared_folders The number of folders that are shared by the user.
links The number of links that are created by the user for sharing the data.
size The total size of data that is shared by the user in MB.

Restore Details API

 
  • Description - Retrieves information on restores that occurred in inSync.
  • Request: GET /api/reports/v1/restoredetails HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"restore_end_time": "02/18/16 13:34"}...]}

Following table lists the attributes that are fetched when you use the Restore Details API.

Attribute Description
email_id The email address of the user.
device_name The name of the device on which restored occurred.
no_of_files The number of files restored.
system_settings_restore The status of whether the device's system settings were restored.
restore_status The status of the restore operation that occurred.
restore_size The total size of restored data in MB.
restore_start_time The date and time when restore started.
restore_end_time The date and time when restore completed.
mode

The mode from which the restore action was initiated. Possible modes are as follows:

  • User initiated restore
  • Administrator initiated restore
  • User initiated restore through inSync Web.
  • User initiated restore through inSync mobile app.

Cloud Storage Details API

 
  • Description - Retrieves storage information used by your organization.
  • Request: GET /api/reports/v1/storages HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"storage_usage": "125.40"}...]}

Following table lists the attributes that are fetched when you use the Cloud Storage Details API.

Attribute Description
storage_name The name of the storage.
no_of_users The number of users assigned to the storage.
total_size_of_backed_up_files The amount of space consumed by the backup data on storage in MB.
storage_usage The total size of the backup data on the storage.

CloudCache Details API

 
  • Description - Retrieves information on usage of inSync CloudCache Server for your organization.
  • Request: GET /api/reports/v1/cloudcachedetails HTTP/1.1
  • Request_Headers: Authorization = <LOGIN CREDENTIALS>
  • Response (JSON):
    • HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
    • HTTP/1.1 200 : {"data":[{"cache_usage": "151.00"}...]}

Following table lists the attributes that are fetched when you use the CloudCache Details API.

Attribute Description
cloudcache_name The name of the CloudCache Server.
no_of_users The number of users that are mapped to the CloudCache Server.
no_of_users_for_restore The number of users that are ready for restore.
total_cache_size The total disk space available for cache data.
cache_usage The total disk space that the cache data consumed until date.