Retrieves all computers details

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 key information for all computers, such as hostname, IP address, OS, status, and remote office details.

Endpoints

Request URL

https://{serverurl}/api/1.4/som/computers

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

residfilterstringOptional

Retrieve a specific computer using it's unique resource_id

fqdnfilterstringOptional

Retrieves the computer using it's Fully Qualified Domain Name(e.g., clientpc01.corp.example.com).

computernamefilterstringOptional

Retrieves the computers based on it's name

domainfilterstringOptional

Retrieves the computers based on the domain it is mapped

branchofficefilterstringOptional

Retrieves the computers using the remote office it is mapped

installstatusfilterstringOptional

Retrieves computers based on their agent installation status.
21: Yet to install (Agent has not been installed)
22: Installed (Agent is currently installed)
23: Uninstalled (Agent has been removed)
31: Uninstallation Failure (An error occured during agent uninstallation)
29: Installation failure (An error occurred during installation)

platformfilterstringOptional

Retrieves the computers based on their OS platform using the numerical codes provided, refer to the following mapping:
0 - Unknown
1 - Windows OS
2- Mac OS
3- Linux OS

agentcontactfilterstringOptional

Retrieves computers based on their last contact time. The following values are supported:
equal_3_day - Agents contacted server in last 3 days
4_day_to_7_day - Agents contacted server between 4 and 7 days ago
8_day_to_15_day - Agents contacted server between 8 and 15 days ago
16_day_to_30_day - Agents contacted server between 16 and 30 days ago
greater_30_day - Agent has not contacted the server in the last 30 days

searchcomputerfilterstringOptional

Retrieves the computers with names containing the specified substring

liveStatusfilterintegerOptional

Retrieves computers based on their live status, The following values are supported:
1 - Live: System is working
2 - Down: System is not working
3 - Unknown: System status is not known.

servicetagfilterstringOptional

Retrieves computers based on their unique service tag

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/1.4/som/computers \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON object
Hide Sub-Attributes
message_typestring

Name of the module

message_responseJSON object

Response message containing computer details

Show Sub-Attributes
totalinteger

Total number of computers

limitinteger

Number of computers per page

pageinteger

Current page number

computersJSON array
Show Sub-Attributes
JSON object
Show Sub-Attributes
modernappdetails.remarksstring

Provides remarks or status information regarding the device's MDM enrollment

remarks_argsstring

List of remarks

agent_installed_oninteger

Shows when the agent was installed (in milliseconds) on the computer

agent_executed_oninteger

Shows when the agent installation process was started (in milliseconds) for the computer

processorarchtype.processor_arch_namestring

Indicates the type of processor architecture used in the computer

os_platform_namestring

Shows the operating system platform running on the device

resource_id_stringstring

A unique string assigned to identify the computer

service_packstring

Displays the operating system's service pack information

computer.processor_arch_type_idinteger

A numeric ID that represents the processor architecture. (Possible values listed below)
1 - Unknown
2 - x86-based PC
3 - x64-based PC
4 - ARM32-based PC
5 - ARM64-based PC

computer.processor_architectureinteger

The processor architecture name. (Possible values listed below)
0 - Unknown
1 - x86-based PC
2 - x64-based PC
3 - ARM32-based PC
4 - ARM64-based PC

os_platforminteger

Represents the OS platform type for the computer. (Possible values listed below)
0 - Unknown
1 - Windows
2 - MAC
3 - Linux

managedcomputer.previous_installation_statusinteger

Shows what the agent's previous installation status was

agent_logged_on_usersstring

Lists the users who are currently logged in on the computer

resourcemacip.dhcp_server_ip_addressstring

Shows the DHCP server's IP address assigned to this computer

osflavor_idinteger

Unique identifier indicates the OS Flavour

search_tagstring

Uniquely identifies the computer based on a customer-provided value. This can be imported by customers the server console under Admin -> Global settings -> Add Custom Data for Computers

status_labelstring

Describes the current status of the agent installation

error_kb_urlstring

Provides a link to a knowledge base article for related errors

full_namestring

Shows the full device name of the computer

owner_email_idstring

Displays the email address of the computer's owner. This can be imported by customers the server console under Admin -> Global settings -> Add Custom Data for Computers

managedcomputertoerrcode.operation_typeinteger

Shows the type of error operation if an error occurred

agent_upgraded_oninteger

Shows when the agent was last upgraded (in milliseconds) on the computer

installation_statusinteger

The agent installation status on the computer. (Possible values listed below)
21 - Yet to install
22 - Installed
23 - Uninstalled
24 - Yet to uninstall
29 - Installation failure

error_codeinteger

Shows an error code related to the agent installation status

managedcomputer.agent_statusinteger

Shows the current upgrade state of the agent

modernappdetails.enrollment_typestring

Displays the type of MDM enrollment used

computer_status_update_timeinteger

Shows when the computer status was last updated (in milliseconds)

managed_statusinteger

Indicates whether the computer is managed or unmanaged. (Possible values listed below)
61 - Managed by DC
62 - Not Managed by DC
68 - Inactive State
65 - Managed by SDP

branch_office_namestring

Name of the branch or remote office where the computer belongs

managedcomputer.re_installation_statusinteger

Indicates the agent installation state. (Possible values listed below)
-1 - Not Applicable
21 - Yet to install
22 - Installed
23 - Uninstalled
29 - Installation failure

agent_last_contact_timeinteger

Shows when the agent last contacted the server (in milliseconds)

descriptionstring

A short description about the computer

domain_netbios_namestring

Shows the NetBIOS domain name of the computer

fqdn_namestring

Shows the full network domain name (FQDN) of the computer

managedcomputer.agent_version_numinteger

Displays the agent version number in numeric format

mac_addressstring

MAC address of this computer's network adapter

ownerstring

Name of the person assigned as the owner of the computer. . This can be imported by customers the server console under Admin -> Global settings -> Add Custom Data for Computers

modernappdetails.last_contact_timeinteger

Shows when the MDM agent last contacted the server (in milliseconds)

managedcomputer.friendly_namestring

A friendly, user-chosen name for the computer

resourcemacip.gateway_ip_addressstring

The default gateway IP configured on the computer

resourcemacip.subnet_maskstring

The subnet mask used by the computer

os_versionstring

The version of the operating system installed

last_sync_timeinteger

Shows when the computer last synced with the server (in milliseconds) from Active Directory

modernappdetails.installed_atinteger

Shows when the MDM agent was installed (in milliseconds)

ip_addressstring

The IP address currently assigned to the computer

agent_uninstalled_oninteger

Shows when the agent was uninstalled from the computer (in milliseconds)

agent_versionstring

The current version of the installed agent

resourcemacip.subnet_ip_addressstring

The subnet IP address assigned to the computer

agent_last_bootup_timeinteger

Shows when the computer was last booted (in milliseconds)

resource_idinteger

Unique ID that identifies the computer

os_namestring

Shows the name of the installed operating system

locationstring

Shows the physical location of the computer. This can be imported by customers the server console under Admin -> Global settings -> Add Custom Data for Computers

managedcomputer.friendly_name_typeinteger

Indicates if the friendly name format of the device has been changed

computer_live_statusinteger

Shows whether the computer is live / reachable. (Possible values listed below)
1 - Live
2 - Down
3 - Unknown

customer_namestring

Displays the customer name associated with the computer

modernappdetails.statusstring

Shows whether the computer is enrolled in MDM or not

resource_namestring

The display name of the computer

customer_idinteger

A unique ID for the customer linked with the computer

remarksstring

Remarks or notes recorded for the computer

message_versionstring

Version of the Api

statusstring

Status of the request

Possible HTTP Status Codes

200HTTP code

Request processed successfully

Sample Response: HTTP 200

Copied!
  {
    "message_type": "computers",
    "message_response": {
      "total": 3,
      "limit": 25,
      "page": 1,
      "computers": [
        {
          "modernappdetails.remarks": "--",
          "remarks_args": "--",
          "agent_installed_on": 1756446785862,
          "agent_executed_on": 1756446785862,
          "processorarchtype.processor_arch_name": "x64-based PC",
          "os_platform_name": "Windows",
          "resource_id_string": "311",
          "service_pack": "Windows 11 Version 24H2 (x64)",
          "computer.processor_arch_type_id": 3,
          "computer.processor_architecture": 2,
          "os_platform": 1,
          "managedcomputer.previous_installation_status": -1,
          "agent_logged_on_users": "Alex",
          "resourcemacip.dhcp_server_ip_address": "10.92.2.20",
          "osflavor_id": 0,
          "search_tag": "--",
          "status_label": "dc.db.som.status.installed_successfully",
          "error_kb_url": "--",
          "full_name": "Alex",
          "owner_email_id": "--",
          "managedcomputertoerrcode.operation_type": 0,
          "agent_upgraded_on": -1,
          "installation_status": 22,
          "error_code": 0,
          "managedcomputer.agent_status": 0,
          "modernappdetails.enrollment_type": "--",
          "computer_status_update_time": 1756447132008,
          "managed_status": 61,
          "branch_office_name": "Local Office",
          "managedcomputer.re_installation_status": -1,
          "agent_last_contact_time": 1756463358000,
          "description": "--",
          "domain_netbios_name": "WORKGROUP",
          "fqdn_name": "ALEX.WORKGROUP.COM",
          "managedcomputer.agent_version_num": 114252201,
          "mac_address": "a0:ce:c8:b9:ae:15",
          "owner": "--",
          "modernappdetails.last_contact_time": 0,
          "managedcomputer.friendly_name": "a0:ce:c8:b9:ae:15 WORKGROUP 10.92.11.44",
          "resourcemacip.gateway_ip_address": "10.92.8.1",
          "resourcemacip.subnet_mask": "255.255.252.0",
          "os_version": "10.0.26100",
          "last_sync_time": 1756463913344,
          "modernappdetails.installed_at": 0,
          "ip_address": "10.92.11.44",
          "agent_uninstalled_on": -1,
          "agent_version": "11.4.2522.01.W",
          "resourcemacip.subnet_ip_address": "10.92.8.0",
          "agent_last_bootup_time": 1756275716000,
          "resource_id": 311,
          "os_name": "Windows 11 Professional Edition (x64)",
          "location": "--",
          "managedcomputer.friendly_name_type": 0,
          "computer_live_status": 1,
          "customer_name": "DC_CUSTOMER",
          "modernappdetails.status": "--",
          "resource_name": "Alex",
          "customer_id": 1,
          "remarks": "dc.db.agent.install.success"
        }
      ]
    },
    "message_version": "1.4",
    "status": "success"
  }
▼ 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.

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