Retrieves File Shadow Operation Details across the Network.

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API lists all file shadow operations performed on network-connected devices. It supports filters based on status, time period, domain, computer, group, and recent activity.

Request URL

https://{serverurl}/api/1.4/reports/dcm/fileshadow Copied!

Scope

DesktopCentralCloud.DeviceControl.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageintegerOptional

Current page number for pagination

pagelimitintegerOptional

Number of records per page

gidlongOptional

Filter devices connected to a group of computers based on its group ID. Group IDs can be obtained from /api/1.4/customgroup/getCGList

numberOfDayslongOptional

Filter file activities that occurred in the last N days

periodintegerOptional

Filter based on time period
0 - This week
1 - This month
2 - This year
3 - Last week
4 - Last month
5 - Last 2 months
6 - Last 3 months
7 - Last 6 months
8 - Last 9 months
9 - Last year

startlongOptional

Start timestamp for date range filter

endlongOptional

End timestamp for date range filter

statuslongOptional

Filter records based on file shadow status
1 - Yet to start
2 - Excluded
3 - Wait
4 - Ready
5 - In progress
6 - Success
7 - Failed
8 - Cancelled

domainstringOptional

Filter the records based on domain names

computerlongOptional

Filter devices connected to a particular computer. Resource IDs can be obtained from /api/1.0/som/computers

userlongOptional

Filter by user resource ID

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/reports/dcm/fileshadow \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
string

Sample Response: HTTP 200

File shadow report response

Copied!
  {
    "response_code": 200,
    "message_type": "dcm",
    "message_response": {
      "total": 1,
      "limit": 25,
      "page": 1,
      "dcm": [
        {
          "custom_device_name": "--",
          "extension": "xml",
          "last_modified_time": 1756101935079,
          "computerresource.domain_netbios_name": "WORKGROUP",
          "file_name": "metadata.xml",
          "managedcomputer.friendly_name": "John",
          "vendor_hex_id": "0781",
          "serial_number": "04015160df329088ed07728df07b1a1c737c3aff5aab42687e3a3fafcf59e155b5871111000000000000000026af6cefff9d8118ab5581077e2d235c",
          "remote_shadow_path": "\\\\SYSTEM-1\\SYS\\2025-08-25\\WORKGROUP\\John\\John\\2025-08-25--06-05-06-257 -  USB  SanDisk 3.2Gen1 USB Device\\New folder\\metadata.xml",
          "userresource.name": "John",
          "connected_time": 1756101906257,
          "device_name": " USB  SanDisk 3.2Gen1 USB Device",
          "source_file_path": "E:\\New folder\\metadata.xml",
          "product_hex_id": "55ab",
          "finalstatus.overall_status": "dc.common.SUCCESS",
          "file_shadow_remarks": "smp.agent.fs.SUCCESS",
          "file_length": 2345,
          "computerresource.name": "John"
        }
      ]
    },
    "message_version": "1.4",
    "status": "success"
  }
                
▼ Show full