Retrieves computer details such as logged-on users, OS platform, domain name, and IP address

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

Retrieves the system details for the specified computer including logged-on users, OS platform, domain name, and IP address. Used to initialize the System Manager view for a target endpoint.

Request URL

https://{serverurl}/dcapi/tools/systemManager/{resourceId}

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

resourceIdstringMandatory

The unique identifier of the target device

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/systemManager/{resourceId} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
resourceIdlong

Unique resource identifier

computerNamestring

Computer name

domainNamestring

Domain name

platformstring

OS platform: Windows, macOS, or Linux

osNamestring

Full OS name and edition

ipAddressstring

IP address of the computer

loggedOnUserstring

Currently active logged-on user

isOnlineboolean

Device reachability status

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "resourceId": 101,
    "computerName": "WIN-DESKTOP-01",
    "domainName": "CORP",
    "loggedOnUser": "john.doe",
    "ipAddress": "192.168.1.50",
    "isOnline": true,
    "osName": "Windows 11 Pro",
    "platform": "Windows"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.