Retrieve hardware categories detected for a computer

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns the list of hardware categories detected for a computer, such as BIOS, processor, memory, disk, network, and other components.

Request URL

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

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/availableHardware.v1+jsonapplication/availableHardware.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}/availableHardware \
  --header 'Accept: application/availableHardware.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
{hardwareTypeID}string

Key-value pairs where the key is the hardware type ID and the value is the hardware type name (e.g., Processor, BIOS, Network Adapter, TPM, etc.)

- 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

Available hardware types

Copied!
  {
    "2": "BIOS",
    "3": "Processor",
    "5": "Keyboard",
    "6": "Sound Device",
    "7": "Video Controller",
    "8": "Pointing Device",
    "13": "Hard Drive",
    "14": "USB Controller",
    "15": "USB Hub",
    "16": "Serial Port",
    "17": "Desktop Monitor",
    "22": "Network Adapter",
    "27": "Physical Memory",
    "36": "Mother Board",
    "43": "TPM"
  }
                
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.