Retrieve complete hardware inventory of a computer

Returns the complete hardware inventory of a computer including all hardware components such as BIOS, processor, memory, disk, network adapter, and peripherals.

Endpoints

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

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/hardwareInfo.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}/hardware \
  --header 'Accept: application/hardwareInfo.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}/hardware"))
        .header("Accept", "application/hardwareInfo.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/hardwareInfo.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

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

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

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


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

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

    info response;

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

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

processorDetailsarray

Array of processor component details

diskDriveDetailsarray

Array of disk drive component details

logicalDiskDetailsarray

Array of logical disk details

motherBoardDetailsarray

Array of motherboard details

biosDetailsarray

Array of BIOS details

networkAdapterDetailsarray

Array of network adapter details

videoControllerDetailsarray

Array of video controller details

soundDeviceDetailsarray

Array of sound device details

keyboardDetailsarray

Array of keyboard details

pointingDeviceDetailsarray

Array of pointing device details

printerDetailsarray

Array of printer details

monitorDetailsarray

Array of monitor details

usbControllerDetailsarray

Array of USB controller details

usbHubDetailsarray

Array of USB hub details

serialPortDetailsarray

Array of serial port details

physicalMemorySlotDetailsarray

Array of physical memory slot details

physicalMemoryDetailsarray

Array of physical memory summary details

tpmDetailsarray

Array of TPM details

batteryDetailsarray

Array of battery details

cdromDetailsarray

Array of CD-ROM details

modemDetailsarray

Array of modem details

parallelPortDetailsarray

Array of parallel port details

pcmciaDetailsarray

Array of PCMCIA details

mappedLogicalDiskDetailsarray

Array of mapped logical disk details

- 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

All hardware components (showing processorDetails and diskDriveDetails only)

Copied!

  {
    "processorDetails": [
      {
        "hardwareDescription": "Sample Family",
        "hardwareStatusDescription": "Not Available",
        "hardwareDeviceID": "CPU0",
        "voltageCapability": "--",
        "hardwareType": "Processor",
        "hardwareInstalledComputerID": "301",
        "hardwareStatus": "OK",
        "processorVersion": "--",
        "hardwareDetectdTime": "May 14, 2026 03:02 PM",
        "numberOfLogicalProcessors": 12,
        "hardwareTypeID": 3,
        "hardwareManufacturerID": "2",
        "hardwareName": "Sample Processor @ 3.20GHz",
        "clockSpeed": 3192,
        "noOfCores": 6,
        "hardwareID": "2",
        "hardwareManufacturer": "SampleManufacturer",
        "processorFamily": "Sample Processor Family",
        "chipSocketDesignation": "U3E1"
      }
    ],
    "usbControllerDetails": [],
    "pcmciaDetails": [],
    "monitorDetails": [],
    "networkAdapterDetails": [],
    "biosDetails": [],
    "printerDetails": [],
    "cdromDetails": [],
    "batteryDetails": [],
    "physicalMemorySlotDetails": [],
    "soundDeviceDetails": [],
    "diskDriveDetails": [
      {
        "hardwareDescription": "Disk drive",
        "totalSizeInBytes": "954 GB",
        "hardwareStatusDescription": "Not Available",
        "serialNumber": "SAMPLE_SERIAL",
        "hardwareDeviceID": "\\\\.\\PHYSICALDRIVE0",
        "freeSizeInGB": 601,
        "freeSpaceInBytes": "645111586816",
        "hardwareType": "Disk Drive",
        "storageMedium": "Unspecified",
        "hardwareInstalledComputerID": "301",
        "hardwareStatus": "OK",
        "totalCylinders": 124519,
        "hardwareDetectdTime": "May 14, 2026 03:02 PM",
        "hardwareTypeID": 13,
        "totalSizeInGB": 954,
        "hardwareManufacturerID": "9",
        "diskDriveName": "Sample Disk 1024GB",
        "hardwareName": "Sample Disk 1024GB",
        "bytesPerSector": "512",
        "hardwareID": "12",
        "hardwareManufacturer": "(Standard disk drives)",
        "sectorPerTrack": "63"
      }
    ],
    "serialPortDetails": [],
    "videoControllerDetails": [],
    "logicalDiskDetails": [],
    "modemDetails": [],
    "keyboardDetails": [],
    "tpmDetails": [],
    "mappedLogicalDiskDetails": [],
    "parallelPortDetails": [],
    "motherBoardDetails": [],
    "physicalMemoryDetails": [],
    "pointingDeviceDetails": [],
    "usbHubDetails": []
  }

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