Retrieve scan status of managed computers

Returns the list of computers along with their scan status, agent install status, and agent live status.

Endpoints

get /dcapi/inventory/viewData/scanComputers

Copy full URL

Request URL

https://{serverurl}/dcapi/inventory/viewData/scanComputers

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/InventoryMobileAPI.v1+jsonCopied!

- Query Parameters

toolIDstringMandatory

Set value as 2131

domainstringOptional

Domain name to filter computers. Obtain from the response of the Get Computers List API.

customGroupstringOptional

Custom group ID to filter computers. Obtain it from the response of the Get Custom Group List API.

scanFilterstringOptional

Scan filter status. Allowed values: 21 - Yet to install, 22 - Installed, 23 - Uninstalled, 24 - Yet to uninstall, 29 - Installation failure

scanStatusstringOptional

Scan status. Allowed values: -1 - Not done, 0 - Failed, 1 - In progress, 2 - Success

agentStatusstringOptional

Agent live status. Allowed values: 1 - Live, 2 - Down, 3 - Unknown

resIDstringOptional

Resource ID 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/viewData/scanComputers?toolID=2131' \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

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://appdomains/dcapi/inventory/viewData/scanComputers?toolID=2131"))
        .header("Accept", "application/InventoryMobileAPI.v1+json")
        .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());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = {
    'Accept': "application/InventoryMobileAPI.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/inventory/viewData/scanComputers?toolID=2131", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    parameters = "toolID=value";

    headersMap = Map();
    headersMap.put("Accept", "application/InventoryMobileAPI.v1+json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/inventory/viewData/scanComputers" + "?" + parameters
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/InventoryMobileAPI.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/inventory/viewData/scanComputers?toolID=2131' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

metadataJSON Object

Pagination metadata

Show Sub-Attributes

limitstring

Number of items returned per page

pagestring

Current page number in paginated response

totalRecordsstring

Total number of records matching the query

messageResponseJSON Array

Array of computer scan detail objects

Show Sub-Attributes

JSON Object

Show Sub-Attributes

agent_version_transformstring

Agent version display value

resource_name_transformstring

Computer name display value

agent_installed_onstring

Agent installation time as epoch timestamp

process_start_timestring

Scan process start time as epoch timestamp

service_packstring

OS service pack or version details

os_name_transformstring

Operating system name display value

software_namestring

Operating system software name

domain_netbios_name_transformstring

Domain NetBIOS name display value

scan_remarksstring

Scan remarks i18n key

branch_office_name_transformstring

Branch office name display value

agent_last_contact_time_transformstring

Agent last contact time display value

os_platformstring

OS platform identifier

fqdn_name_transformstring

FQDN display value

status_labelstring

Installation status i18n key

audit_type_transformstring

Scan audit type display value

namestring

Logged-in user name

installation_statusstring

Agent installation status code

scan_status_transformstring

Scan status code display value

os_version_transformstring

OS version display value

friendly_name_transformstring

Friendly name display value

last_successful_scanstring

Last successful scan time as epoch timestamp

scan_remarks_transformstring

Scan remarks display value

branch_office_namestring

Branch office name

agent_last_contact_timestring

Agent last contact time as epoch timestamp

domain_netbios_namestring

Domain NetBIOS name

process_end_time_transformstring

Scan process end time display value

status_label_transformstring

Installation status display value

fqdn_namestring

Fully qualified domain name

ip_address_transformstring

IP address display value

agent_installed_on_transformstring

Agent installation time display value

mac_addressstring

MAC address

scan_remarks_enstring

Scan remarks in English

friendly_namestring

Computer friendly name

scan_statusstring

Scan status code

last_successful_scan_transformstring

Last successful scan time display value

os_versionstring

OS version string

process_end_timestring

Scan process end time as epoch timestamp

ip_addressstring

IP address

service_pack_transformstring

Service pack display value

agent_versionstring

Agent version string

mac_address_transformstring

MAC address display value

name_transformstring

User name display value

servicetagstring

Service tag

resource_idstring

Resource identifier

build_numberstring

OS build number

os_namestring

Operating system name

computer_live_statusstring

Computer live status code

resource_namestring

Computer resource name

customer_idstring

Customer identifier

build_number_transformstring

Build number display value

servicetag_transformstring

Service tag display value

scan_remarks_en_transformstring

Scan remarks English display value

audit_typestring

Audit type code

totalPagesstring

Total number of pages

LinksJSON Object

Pagination links

Show Sub-Attributes

nextstring

URL to the next page of results, null if last page

prevstring

URL to the previous page of results, null if first page

statusstring

Response status - success

- 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

500HTTP code

Sample Response: HTTP 200

Scan computers view

Copied!

  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "agent_version_transform": "11.5.2613.01.W",
        "resource_name_transform": "sample-computer",
        "agent_installed_on": "1778751125720",
        "process_start_time": "-1",
        "service_pack": "Windows 11 Version 25H2 (x64)",
        "os_name_transform": "Windows 11 Professional Edition (x64)",
        "software_name": "Windows 11 Professional Edition (x64)",
        "domain_netbios_name_transform": "WORKGROUP",
        "scan_remarks": "dc.common.SCANNING_COMPLETED",
        "branch_office_name_transform": "Local Office",
        "agent_last_contact_time_transform": "May 14, 2026 04:30 PM",
        "os_platform": "1",
        "fqdn_name_transform": "SAMPLE-COMPUTER.DOMAIN.COM",
        "status_label": "dc.db.som.status.installed_successfully",
        "audit_type_transform": "On-demand Scan",
        "name": "SampleUser",
        "installation_status": "22",
        "scan_status_transform": "2",
        "os_version_transform": "10.0.26200",
        "friendly_name_transform": "sample-computer",
        "last_successful_scan": "1778751156691",
        "scan_remarks_transform": "Scanning Completed",
        "branch_office_name": "Local Office",
        "agent_last_contact_time": "1778756427000",
        "domain_netbios_name": "WORKGROUP",
        "process_end_time_transform": "May 14, 2026 03:02 PM",
        "status_label_transform": "Installed Successfully",
        "fqdn_name": "SAMPLE-COMPUTER.DOMAIN.COM",
        "ip_address_transform": "10.0.0.1",
        "agent_installed_on_transform": "May 14, 2026 03:02 PM",
        "mac_address": "00:00:00:00:00:00",
        "scan_remarks_en": "Scanning Completed",
        "friendly_name": "sample-computer",
        "scan_status": "2",
        "last_successful_scan_transform": "May 14, 2026 03:02 PM",
        "os_version": "10.0.26200",
        "process_end_time": "1778751156691",
        "ip_address": "10.0.0.1",
        "service_pack_transform": "Windows 11 Version 25H2 (x64)",
        "agent_version": "11.5.2613.01.W",
        "mac_address_transform": "00:00:00:00:00:00",
        "name_transform": "SampleUser",
        "servicetag": "SAMPLE01",
        "resource_id": "301",
        "build_number": "26200.8246",
        "os_name": "Windows 11 Professional Edition (x64)",
        "computer_live_status": "1",
        "resource_name": "sample-computer",
        "customer_id": "1",
        "build_number_transform": "26200.8246",
        "servicetag_transform": "SAMPLE01",
        "scan_remarks_en_transform": "Scanning Completed",
        "audit_type": "1"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }

▼ 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.