Get general information of a computer

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 provides a high-level summary of a computer's general information, including customer and resource identifiers, domain, operating system details, network configuration, scan history, warranty status, and logged-in user information

Request URL

https://{serverurl}/dcapi/inventory/computers/{resourceID}/generalSummary

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/computerInfo.v1+jsonapplication/computerInfo.v1+jsonCopied!

- Path Parameters

resourceIDstringMandatory

Resource identifier of the computer. Obtain from the response of the Get Computers List API.

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/inventory/computers/{resourceID}/generalSummary \
  --header 'Accept: application/computerInfo.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Informational message about power event availability

customerIDstring

Customer identifier

isHPMachinestring

Whether the machine is an HP device - Yes or No

showModernManagementInfostring

Whether to show modern management info - Yes or No

lastBootTimestring

Last boot time in human-readable format

isClosedNetworkstring

Whether the computer is in a closed network - Yes or No

resourceNamestring

Computer name

resourceIDstring

Unique resource identifier

isWarrantyExpiredstring

Whether warranty has expired - Yes or No

lastSuccessfulScanTimestring

Last successful scan time in human-readable format

metroAppScanStatusstring

Metro/Store app scan status code

resourceTypestring

Resource type identifier

domainNamestring

Domain or workgroup name

osLanguagestring

Operating system language

macAddressstring

Primary MAC address

isScannedstring

Whether the computer has been scanned - Yes or No

isVMEnabledstring

Whether virtualization is enabled - Yes or No

licenseStatusstring

License status - Licensed or Unlicensed

isServerOSstring

Whether the OS is a server OS - Yes or No

ipAddressstring

Primary IP address

currentLoggedUserstring

Currently logged-in user

primaryOwnerNamestring

Primary owner name

operatingSystemIDstring

Operating system identifier

lastSyncTimestring

Last sync time in human-readable format

lastLoggedUserstring

Last logged-in user

lastScanInitiatedTimestring

Last scan initiated time

isProxyDefinedstring

Whether a proxy is defined - Yes or No

- HTTP code 401

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

UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing

error_descriptionstring

Authentication or authorization failure reason

- HTTP code 404

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

RESOURCE_NOT_AVAILABLE - the specified resourceID does not exist or is not accessible

error_descriptionstring

Resource not found message

- HTTP code 500

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

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible Response Codes

200HTTP code
401HTTP code
404HTTP code
500HTTP code

Sample Response: HTTP 200

General summary of a computer

Copied!
  {
    "lastSyncTime": "May 15, 2026 12:04 PM",
    "isClosedNetwork": "No",
    "lastScanInitiatedTime": "May 14, 2026 07:35 PM",
    "operatingSystemID": 1,
    "isServerOS": "No",
    "isProxyDefined": "Yes",
    "osLanguage": "English",
    "primaryOwnerName": "--",
    "resourceID": "301",
    "showModernManagementInfo": "No",
    "isHPMachine": "No",
    "isWarrantyExpired": "Yes",
    "ipAddress": "10.0.0.1",
    "metroAppScanStatus": 0,
    "resourceName": "sample-computer",
    "isVMEnabled": "No",
    "lastSuccessfulScanTime": "May 14, 2026 07:35 PM",
    "powerEventViewMsg": "This system was recently onboarded, and the power events that occurred after onboarding will only be available. The power events will be cleaned up 30 days after their occurrence.",
    "macAddress": "00:00:00:00:00:00",
    "currentLoggedUser": "SampleUser",
    "licenseStatus": "Licensed",
    "domainName": "WORKGROUP",
    "customerID": "1",
    "lastBootTime": "Apr 30, 2026 01:20 PM",
    "isScanned": "Yes",
    "resourceType": 1,
    "lastLoggedUser": "--"
  }
                
Show full

Sample Response: HTTP 401

Missing credentials

Copied!
  {
    "error_description": "Unauthorized access",
    "error_code": "UAC_UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 404

Resource not found

Copied!
  {
    "error_description": "The specified resource was not found",
    "error_code": "RESOURCE_NOT_AVAILABLE"
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | 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.