# Retrieves all computers details Provides JSON objects containing key information for all computers, such as hostname, IP address, OS, status, and remote office details. ## Endpoint `GET /api/1.4/som/computers` ## Request URL `https://{serverurl}/api/1.4/som/computers` `{serverurl}`: [OAuth Authentication Endpoint Domain](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html) ## Scope `DesktopCentralCloud.Common.READ` ## Header ```text Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52 ``` ## Request Parameters ### Query Parameters | Parameter | Type | Required | Description | |---|---|---|---| | `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. Supported values:
`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. Supported values:
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 ```bash curl --request GET \ --url https://appdomains/api/1.4/som/computers \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' ``` ## Response Parameters ### HTTP Code 200 Response body: `application/json` | Parameter | Type | Description | |---|---|---| | `message_type` | string | Name of the module | | `message_response` | JSON Object | Response message containing computer details | | `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" } ``` ## Rate Limit **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.