Retrieves detailed information for all computers

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

Provides JSON objects containing detailed information for all computers, such as hostname, IP address, OS, status, remote office details, and more.

Endpoints

Request URL

https://{serverurl}/dcapi/som/computersInfo

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageintegerOptional

Specifies the page number to retrieve. Default is 1

sizestringOptional

Specifies the maximum number of items to return per page. The default value is 25. A maximum of 1000 records can be retrieved in a single request

domainNamestringOptional

Returns computers that match the specified domain name.

liveSyncStatusstringOptional

Returns computers based on their current live status. Supported values are:
up : The system is working
down : The system is not working
unknown: The system status is not known.

lastContactTimestringOptional

Returns computers that last contacted the server at the specified time in milliseconds.

lastContactOperatorstringOptional

Specifies the comparison operator used for filtering by last contact time. Supported values are:
gt - Greater than
ge - Greater than or equal to
lt - Less than
le - Less than or equal to
ne - Not equal

computerNamestringOptional

Returns computers that matches the specified computer names.

computerIDstringOptional

Returns computers that matches the computerID

agentVersionstringOptional

Returns computers that match the specified agent version number, such as 11.5.2614.01.W

remoteOfficeIDstringOptional

Returns computers that belong to the specified remote office ID. Use the resource_id field from the Get Remote Offices API response.

customGroupIDstringOptional

Returns computers that belong to the specified custom groups. Use the group_id field from the Get Custom Groups API response.

adOuGuidstringOptional

Returns computers that belong to the specified Active Directory organizational unit GUID.

adOuNamestringOptional

Returns computers that belong to the specified Active Directory organizational unit name.

adOuDnNamestringOptional

Returns computers that belong to the specified Active Directory organizational unit distinguished name.

ipAddressstringOptional

Returns computers that match the specified IP address.

isManagedstringOptional

Returns only managed computers when set to true.

isServerstringOptional

Returns only server computers when set to true.

isWorkstationstringOptional

Returns only workstation computers when set to true.

serviceTagstringOptional

Returns computers that match the specified service tag.

osPlatformstringOptional

Returns computers that match the specified operating system platform. Supported values are:
0 - Unknown
1 - Windows
2 - Mac
3 - Linux

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/som/computersInfo \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Array
Hide Sub-Attributes
JSON Object
Show Sub-Attributes
managedStatusinteger

Managed status code of the computer

liveStatusUpdatedOnstring

Timestamp indicating when the live status was last updated

ownerEmailIDstring

Email address of the computer owner

installationStatusstring

Current installation status of the agent

descriptionstring

Description of the computer, if provided

computerFullNamestring

Full display name of the computer

agentExecutedOnstring

Timestamp indicating when the agent was last executed

statusUpdatedOnstring

Timestamp indicating when the computer status was last updated

osVersionstring

Version of the operating system installed on the computer

computerNamestring

Hostname of the computer

lastContactTimestring

Timestamp of the last successful communication between the computer and the server

osPlatformstring

Operating system platform (for example, Windows, macOS, Linux)

agentUpgradedOnstring

Timestamp indicating when the agent was last upgraded

liveStatusstring

Current live status of the computer

servicePackstring

Service pack or edition details of the operating system

ipAddressstring

IP address assigned to the computer

installationStatusCodeinteger

Numeric code representing the agent installation status

osNamestring

Name of the operating system installed on the computer

computerFQDNNamestring

Fully Qualified Domain Name (FQDN) of the computer

agentUninstalledOnstring

Timestamp indicating when the agent was uninstalled

searchTagstring

Search tag associated with the computer

computerIdstring

Unique identifier of the computer

macAddressstring

MAC address of the computer's network interface

computerGUIDstring

Globally unique identifier (GUID) of the computer

loggedUsersstring

List of users currently or recently logged in to the computer

distributionServerNamestring

Name of the distribution server managing the computer

domainNamestring

Domain to which the computer belongs

customerIDstring

Unique identifier of the customer associated with the computer

agentVersionstring

Version of the agent installed on the computer

supportedOperationinSDPstring

Operations supported for this computer in ServiceDesk Plus (SDP)

agentInstalledOnstring

Timestamp indicating when the agent was installed

locationstring

Location of the computer, if available

remoteOfficeNamestring

Name of the remote office associated with the computer

remoteOfficeIDstring

Unique identifier of the remote office associated with the computer

remarksstring

Additional remarks or notes associated with the computer

Response Headers


X-Total-Countstring

Indicates the total number of computer records available

Possible Response Codes

200HTTP code

Request processed successfully

Sample Response: HTTP 200

Copied!
  [
    {
      "managedStatus": 61,
      "liveStatusUpdatedOn": "Feb 8, 2023 04:00 PM",
      "ownerEmailID": "--",
      "installationStatus": "Installed Successfully",
      "description": "--",
      "computerFullName": "JACK",
      "agentExecutedOn": "Feb 8, 2023 02:51 PM",
      "statusUpdatedOn": "Feb 8, 2023 02:51 PM",
      "osVersion": "10.0.19045",
      "computerName": "JACK",
      "lastContactTime": "Feb 8, 2023 02:50 PM",
      "osPlatform": "Windows",
      "agentUpgradedOn": "--",
      "liveStatus": "Live",
      "servicePack": "Windows 10 Version 2009 (x64)",
      "ipAddress": "11.33.3.42",
      "installationStatusCode": 22,
      "osName": "Windows 10 Professional Edition (x64)",
      "computerFQDNName": "JACK.EXAMPLE.MAIL.COM",
      "agentUninstalledOn": "--",
      "searchTag": "--",
      "computerId": "601",
      "macAddress": "00:29:0c:aa:00:01,6d:a2:zb:3a:a8:01",
      "computerGUID": "5mtu0yxygxzjliymy0yti4mti1zgi",
      "loggedUsers": "JACK",
      "distributionServerName": "JACK",
      "domainName": "WORKGROUP",
      "customerID": "1",
      "agentVersion": "10.1.2228.20.W",
      "supportedOperationinSDP": "Asset,Remote_Control,Tools",
      "agentInstalledOn": "Feb 8, 2023 01:21 PM",
      "location": "--",
      "remoteOfficeName": "ro1",
      "remoteOfficeID": "301",
      "remarks": "Agent Installed Successfully"
    },
    {
      "managedStatus": 62,
      "liveStatusUpdatedOn": "Feb 7, 2023 06:58 PM",
      "ownerEmailID": "--",
      "installationStatus": "Uninstalled Successfully",
      "description": "--",
      "computerFullName": "ROSE",
      "agentExecutedOn": "Feb 7, 2023 06:52 PM",
      "statusUpdatedOn": "Feb 7, 2023 06:52 PM",
      "osVersion": "10.0.19044",
      "computerName": "ROSE",
      "lastContactTime": "Feb 7, 2023 05:51 PM",
      "osPlatform": "Windows",
      "agentUpgradedOn": "--",
      "liveStatus": "Unknown",
      "servicePack": "Windows 10 Version 21H2 (x64)",
      "ipAddress": "10.51.241.7",
      "installationStatusCode": 23,
      "osName": "Windows 10 Professional Edition (x64)",
      "computerFQDNName": "ROSE.EXAMPLE.MAIL.COM",
      "agentUninstalledOn": "Feb 7, 2023 06:52 PM",
      "searchTag": "--",
      "computerId": "901",
      "macAddress": "0a:00:27:09:00:17,60:a2:89:a4:72:z7",
      "computerGUID": "3mtnjowu0mmi0mjzjmgi2nmqx",
      "loggedUsers": "ROSE-10549",
      "distributionServerName": "JACK",
      "domainName": "WORKGROUP",
      "customerID": "1",
      "agentVersion": "10.1.2228.20.W",
      "supportedOperationinSDP": "Asset",
      "agentInstalledOn": "Feb 6, 2023 10:25 AM",
      "location": "--",
      "remoteOfficeName": "ro1",
      "remoteOfficeID": "301",
      "remarks": "Agent UnInstalled Successfully"
    }
  ]
▼ 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.