Get a consolidated inventory summary of a computer

Provides a consolidated summary of a computer by its ID. The response covers operating system details, software and hardware inventory, disk utilization, and general system information such as network, users, and license status.

Endpoints

get /dcapi/inventory/computers/{resourceID}/summary

Copy full URL

Request URL

https://{serverurl}/dcapi/inventory/computers/{resourceID}/summary

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/computerSummary.v1+jsonCopied!

- Path Parameters

resourceIDstringMandatory

Resource identifier 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/computers/{resourceID}/summary \
  --header 'Accept: application/computerSummary.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/computers/{resourceID}/summary"))
        .header("Accept", "application/computerSummary.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/computerSummary.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/inventory/computers/{resourceID}/summary", headers=headers)

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

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


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

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/inventory/computers/{resourceID}/summary"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/computerSummary.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/inventory/computers/{resourceID}/summary' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

osSummaryJSON Object

Operating system details including OS name, version, service pack, build number, license type, and product ID

Show Sub-Attributes

assetSummaryJSON Object

Asset counts including total software, hardware, prohibited software, commercial software, and missing patches

Show Sub-Attributes

diskUsageSummaryJSON Object

Disk utilization including total size, used/free space in GB and percentages

Show Sub-Attributes

hardwareSummaryJSON Object

Hardware summary including manufacturer, model, processor, RAM, warranty, and service tag

Show Sub-Attributes

generalSummaryJSON Object

General system information including resource details, domain, network, scan status, logged-in user, and license status

Show Sub-Attributes

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

UAC_UNAUTHORIZED - user lacks the required uem-roles or credentials are missing

error_descriptionstring

Authentication or authorization failure reason

- HTTP code 404

Response Body - application/json

JSON Object

Hide Sub-Attributes

error_codestring

RESOURCE_NOT_AVAILABLE - the specified resourceID does not exist or is not accessible

error_descriptionstring

Resource not found message

- 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

401HTTP code

404HTTP code

500HTTP code

Sample Response: HTTP 200

Full inventory summary of a computer

Copied!

  {
    "osSummary": {
      "installedSystemDrive": "C:",
      "registeredTO": "SampleUser",
      "licenseType": "Retail",
      "osBuildNumber": "26200.8246",
      "osVersion": "10.0.26200",
      "productID": "00000-00000-00000-AA000",
      "osServicePack": "Windows 11 Version 25H2 (x64)",
      "osCDKey": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "operatingSystem": "Windows 11 Professional Edition (x64)"
    },
    "hardwareSummary": {
      "computerType": "Desktop",
      "daysToWarrantyExpiry": "-579",
      "shippingDate": "Oct 10, 2019",
      "ramMemory": 16384,
      "manufacturerShortName": "Sample",
      "productNumber": "--",
      "computerManufacturer": "Sample Manufacturer",
      "warrantyExpiryDate": "Oct 11, 2024",
      "serviceTag": "SAMPLE01",
      "epochShippingDate": "1570714200000",
      "epochWarrantyExpiryDate": "1728653399000",
      "processorNames": "Sample Processor @ 3.20GHz",
      "computerAge": "6",
      "processorArchitecture": "x64-based PC",
      "redirectionURL": "https://www.example.com/support/servicetag/SAMPLE01",
      "computerModel": "Sample Model"
    },
    "generalSummary": {
      "resourceID": "301",
      "lastSyncTime": "May 14, 2026 06:03 PM",
      "isHPMachine": "No",
      "isWarrantyExpired": "Yes",
      "ipAddress": "10.0.0.1",
      "resourceName": "sample-computer",
      "lastSuccessfulScanTime": "May 14, 2026 03:02 PM",
      "macAddress": "00:00:00:00:00:00",
      "operatingSystemID": 1,
      "currentLoggedUser": "SampleUser",
      "licenseStatus": "Licensed",
      "domainName": "WORKGROUP",
      "customerID": "1",
      "lastBootTime": "Apr 30, 2026 01:20 PM",
      "isServerOS": "No",
      "isProxyDefined": "Yes",
      "osLanguage": "English",
      "isScanned": "Yes",
      "resourceType": 1
    },
    "assetSummary": {
      "totalHardwaresCount": 24,
      "totalSoftwaresCount": 35,
      "noncommercialSoftwaresCount": 0,
      "desktopAppsCount": 35,
      "missingPatchesCount": 0,
      "commercialSoftwaresCount": 0,
      "windowsStoreAppsCount": 0,
      "prohibitedSoftwaresCount": 0
    },
    "diskUsageSummary": {
      "diskFreePercentage": 63.06,
      "diskSize": 953,
      "diskUsedPercentage": 36.94,
      "diskUsedSize": 352,
      "diskFreeSize": 601
    }
  }

▼ Show full

Sample Response: HTTP 401

Missing credentials

Copied!

  {
    "error_description": "Unauthorized access",
    "error_code": "UAC_UNAUTHORIZED"
  }

▼ Show full

Sample Response: HTTP 404

Resource not found

Copied!

  {
    "error_description": "The specified resource was not found",
    "error_code": "RESOURCE_NOT_AVAILABLE"
  }

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