File Shadowing


This API is for listing all the file shadow operations that have occurred in your network.

 

  • Functionality
  • To retrieve the list of all file shadow operations that have taken place in the network.
  • HTTP Method 
  • GET
  • API URI
  • api/1.4/reports/dcm/fileshadow
  • Filters
  • status={Numeric}
    This is to filter records based on status.
    1 - Yet to start
    2 - Excluded
    3 - Wait
    4 - Ready
    5 - In progress
    6 - Success
    7 - Failed
    8 - Cancelled


    period={Numeric}
    This is to filter based on time period.
    0 - This week
    1 - This month
    2 - This year
    3 - Last week
    4 - Last month
    5 - Last two months
    6 - Last three months
    7 - Last six months
    8 - Last nine months
    9 - Last year

    domain={String}
    Can filter the records based on domain names.

    computer={Numeric}
    This is to filter devices connected to a particular computer based on its resource ID. The resource IDs of all the computers can be obtained from :
    Key: "resource_id"
    /api/1.0/som/computers

    gid={Numeric}
    This is to filter devices connected to a particular group of computers based on its group ID. The group IDs of of all the custom computer groups can be obtained from:
    api/1.0/admin/customgroups

    numberOfDays={Numeric}
    This is to filter the file activities that have occurred in the last n days.
  • Paging
  • page={Numeric}
    This is for navigating to specific pages. This field denotes the current page.

    pagelimit={Numeric}
    This is to specify the number of records to be displayed per page.
  • Response Parameters
  • file_length
    File size will be denoted in bytes.

    All times are in epoch long format.

Response Data

 { 	"message_type": "dcm", 	"message_response": { 		"total": 5000, 		"limit": 25, 		"page": 1, 		"dcm": [ 			{ 				"custom_device_name": "--", 				"extension": "Folder", 				"last_modified_time": 1744214598316, 				"computerresource.domain_netbios_name": "WORKGROUP", 				"file_name": "F:\\temp\\test\\github\\objects\\a7 ", 				"managedcomputer.friendly_name": "04048005Hzbj  56DBQZE", 				"vendor_hex_id": "8086", 				"serial_number": "11583659", 				"remote_shadow_path": "\\\\COMMONSHARE\\F:\\temp\\test\\github\\objects\\a7 ", 				"userresource.name": "04048005Hzbj-User", 				"connected_time": 1744201218392, 				"device_name": "Intel(R) Wi-Fi 6 AX201 160MHz", 				"source_file_path": "F:\\temp\\test\\github\\objects\\a7 ", 				"product_hex_id": "06f0", 				"finalstatus.overall_status": "dc.common.SUCCESS", 				"file_shadow_remarks": "smp.agent.fs.SUCCESS", 				"file_length": 500185391, 				"computerresource.name": "04048005Hzbj" 			}, 			{ 				"custom_device_name": "--", 				"extension": "Folder", 				"last_modified_time": 1744202281707, 				"computerresource.domain_netbios_name": "WORKGROUP", 				"file_name": "F:\\temp\\test\\github\\objects\\fb ", 				"managedcomputer.friendly_name": "04048005Hzbj  56DBQZE", 				"vendor_hex_id": "8086", 				"serial_number": "11583659", 				"remote_shadow_path": "\\\\COMMONSHARE\\F:\\temp\\test\\github\\objects\\fb ", 				"userresource.name": "04048005Hzbj-User", 				"connected_time": 1744201218392, 				"device_name": "Intel(R) Wi-Fi 6 AX201 160MHz", 				"source_file_path": "F:\\temp\\test\\github\\objects\\fb ", 				"product_hex_id": "06f0", 				"finalstatus.overall_status": "dc.common.status.yet_to_start", 				"file_shadow_remarks": "smp.agent.fs.YET_TO_START", 				"file_length": 296681727, 				"computerresource.name": "04048005Hzbj" 			} 		] 	}, 	"message_version": "1.4", 	"status": "success", 	"response_code": 200 }