# Retrieves all computers details Provides JSON objects containing key information for all computers, such as hostname, IP address, OS, status, and remote office details. ## Endpoints **GET** `/api/1.4/som/computers` ## Request URL `https://{serverurl}/api/1.4/som/computers` ## Scope `DesktopCentralCloud.Common.READ` ## Header `Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52` ## Request Parameters ### Query Parameters - **residfilter** (string, Optional) Retrieve a specific computer using it's unique resource_id - **fqdnfilter** (string, Optional) Retrieves the computer using it's Fully Qualified Domain Name (e.g., clientpc01.corp.example.com). - **computernamefilter** (string, Optional) Retrieves the computers based on it's name - **domainfilter** (string, Optional) Retrieves the computers based on the domain it is mapped - **branchofficefilter** (string, Optional) Retrieves the computers using the remote office it is mapped - **installstatusfilter** (string, Optional) 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) - **platformfilter** (string, Optional) Retrieves the computers based on their OS platform using the numerical codes provided: 0 - Unknown 1 - Windows OS 2 - Mac OS 3 - Linux OS - **agentcontactfilter** (string, Optional) 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 - **searchcomputerfilter** (string, Optional) Retrieves the computers with names containing the specified substring - **liveStatusfilter** (integer, Optional) Retrieves computers based on their live status: 1 - Live: System is working 2 - Down: System is not working 3 - Unknown: System status is not known - **servicetagfilter** (string, Optional) Retrieves computers based on their unique service tag ## Sample Request ### Curl ```bash curl --request GET \ --url https://appdomain/api/1.4/som/computers \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ### Java ```java import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.io.IOException; import java.net.http.HttpTimeoutException; public class Main { public static void main(String[] args) { HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://appdomain/api/1.4/som/computers")) .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body()); } } ``` ### Python ```python import http.client conn = http.client.HTTPSConnection("appdomain") headers = { 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" } conn.request("GET", "/api/1.4/som/computers", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) ``` ### Deluge ```javascript headersMap = Map(); headersMap.put("Accept", "application/json"); response = invokeUrl [ url: "https://appDomain/api/1.4/som/computers" type: GET headers: headersMap connection: connection_name ] info response; ``` ### PowerShell ```powershell $headers=@{} $headers.Add("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") $response = Invoke-WebRequest -Uri 'https://appdomain/api/1.4/som/computers' -Method GET -Headers $headers ``` ## Response Parameters ### HTTP code 200 **Response Body**: `application/json` - **message_type** (string) Name of the module - **message_response** (JSON object) Response message containing computer details - **total** (integer) Total number of computers - **limit** (integer) Number of computers per page - **page** (integer) Current page number - **computers** (JSON array) - **modernappdetails.remarks** (string) Provides remarks or status information regarding the device's MDM enrollment - **remarks_args** (string) List of remarks - **agent_installed_on** (integer) Shows when the agent was installed (in milliseconds) on the computer - **agent_executed_on** (integer) Shows when the agent installation process was started (in milliseconds) for the computer - **processorarchtype.processor_arch_name** (string) Indicates the type of processor architecture used in the computer - **os_platform_name** (string) Shows the operating system platform running on the device - **resource_id_string** (string) A unique string assigned to identify the computer - **service_pack** (string) Displays the operating system's service pack information - **computer.processor_arch_type_id** (integer) A numeric ID that represents the processor architecture: 1 - Unknown 2 - x86-based PC 3 - x64-based PC 4 - ARM32-based PC 5 - ARM64-based PC - **computer.processor_architecture** (integer) The processor architecture name: 0 - Unknown 1 - x86-based PC 2 - x64-based PC 3 - ARM32-based PC 4 - ARM64-based PC - **os_platform** (integer) Represents the OS platform type: 0 - Unknown 1 - Windows 2 - MAC 3 - Linux - **managedcomputer.previous_installation_status** (integer) Shows what the agent's previous installation status was - **agent_logged_on_users** (string) Lists the users who are currently logged in on the computer - **resourcemacip.dhcp_server_ip_address** (string) Shows the DHCP server's IP address assigned to this computer - **osflavor_id** (integer) Unique identifier indicates the OS Flavour - **search_tag** (string) Uniquely identifies the computer based on a customer-provided value - **status_label** (string) Describes the current status of the agent installation - **error_kb_url** (string) Provides a link to a knowledge base article for related errors - **full_name** (string) Shows the full device name of the computer - **owner_email_id** (string) Displays the email address of the computer's owner - **managedcomputertoerrcode.operation_type** (integer) Shows the type of error operation if an error occurred - **agent_upgraded_on** (integer) Shows when the agent was last upgraded (in milliseconds) - **installation_status** (integer) The agent installation status: 21 - Yet to install 22 - Installed 23 - Uninstalled 24 - Yet to uninstall 29 - Installation failure - **error_code** (integer) Shows an error code related to the agent installation status - **managedcomputer.agent_status** (integer) Shows the current upgrade state of the agent - **modernappdetails.enrollment_type** (string) Displays the type of MDM enrollment used - **computer_status_update_time** (integer) Shows when the computer status was last updated (in milliseconds) - **managed_status** (integer) Indicates whether the computer is managed or unmanaged: 61 - Managed by DC 62 - Not Managed by DC 68 - Inactive State 65 - Managed by SDP - **branch_office_name** (string) Name of the branch or remote office where the computer belongs - **managedcomputer.re_installation_status** (integer) Indicates the agent installation state: -1 - Not Applicable 21 - Yet to install 22 - Installed 23 - Uninstalled 29 - Installation failure - **agent_last_contact_time** (integer) Shows when the agent last contacted the server (in milliseconds) - **description** (string) A short description about the computer - **domain_netbios_name** (string) Shows the NetBIOS domain name of the computer - **fqdn_name** (string) Shows the full network domain name (FQDN) of the computer - **managedcomputer.agent_version_num** (integer) Displays the agent version number in numeric format - **mac_address** (string) MAC address of this computer's network adapter - **owner** (string) Name of the person assigned as the owner of the computer - **modernappdetails.last_contact_time** (integer) Shows when the MDM agent last contacted the server (in milliseconds) - **managedcomputer.friendly_name** (string) A friendly, user-chosen name for the computer - **resourcemacip.gateway_ip_address** (string) The default gateway IP configured on the computer - **resourcemacip.subnet_mask** (string) The subnet mask used by the computer - **os_version** (string) The version of the operating system installed - **last_sync_time** (integer) Shows when the computer last synced with the server (in milliseconds) - **modernappdetails.installed_at** (integer) Shows when the MDM agent was installed (in milliseconds) - **ip_address** (string) The IP address currently assigned to the computer - **agent_uninstalled_on** (integer) Shows when the agent was uninstalled from the computer (in milliseconds) - **agent_version** (string) The current version of the installed agent - **resourcemacip.subnet_ip_address** (string) The subnet IP address assigned to the computer - **agent_last_bootup_time** (integer) Shows when the computer was last booted (in milliseconds) - **resource_id** (integer) Unique ID that identifies the computer - **os_name** (string) Shows the name of the installed operating system - **location** (string) Shows the physical location of the computer - **managedcomputer.friendly_name_type** (integer) Indicates if the friendly name format of the device has been changed - **computer_live_status** (integer) Shows whether the computer is live / reachable: 1 - Live 2 - Down 3 - Unknown - **customer_name** (string) Displays the customer name associated with the computer - **modernappdetails.status** (string) Shows whether the computer is enrolled in MDM or not - **resource_name** (string) The display name of the computer - **customer_id** (integer) A unique ID for the customer linked with the computer - **remarks** (string) Remarks or notes recorded for the computer - **message_version** (string) Version of the API - **status** (string) Status of the request ## Sample Response: HTTP 200 ```json { "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" } ``` ## Possible HTTP Status Codes - **200** — Request processed successfully ## Rate Limiting **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.