Retrieve computers where a specific prohibited software is detected by using Query param prohibitedswid={software_id}

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 computers that have the specified prohibited software installed. Use the query parameter prohibitedswid to specify the prohibited software.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/InventoryMobileAPI.v1+jsonapplication/InventoryMobileAPI.v1+jsonCopied!

- Query Parameters

toolIDstringMandatory

Set value as 4202

prohibitedswidstringMandatory

Prohibited software ID to filter by prohibited software. Obtain from the response of the Get Prohibited Software List API.

domainstringOptional

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

branchOfficestringOptional

Branch office ID to filter computers. Obtain it from the response of the Get Remote Office List API.

customGroupstringOptional

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

liveStatusstringOptional

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

architecturestringOptional

OS architecture filter. Allowed values: 32-bit - 32 bit OS, 64-bit - 64 bit OS

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/inventory/viewData/computersBySW?toolID=4202&prohibitedswid=SOME_STRING_VALUE' \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

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 detail objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
resource_name_transformstring

Computer name display value

model_transformstring

Computer model display value

installed_date_transformstring

Installation date display value

architecture_transformstring

Architecture display value

uninstall_remarksstring

Uninstall remarks

processor_arch_namestring

Processor architecture name

uninstall_remarks_transformstring

Uninstall remarks display value

sw_usage_typestring

Software usage type i18n key

branch_office_idstring

Branch office identifier

modelstring

Computer model

os_name_transformstring

OS name display value

installed_datestring

Installation date as epoch timestamp

software_namestring

Software name

software_versionstring

Software version

domain_netbios_name_transformstring

Domain NetBIOS name display value

computer_resource_idstring

Computer resource identifier

asset_tagstring

Asset tag

software_name_transformstring

Software name display value

location_transformstring

Installation location display value

branch_office_name_transformstring

Branch office name display value

asset_tag_transformstring

Asset tag display value

os_platformstring

OS platform identifier

agent_logged_on_usersstring

Currently logged-on user

fqdn_name_transformstring

FQDN display value

display_namestring

Software display name

osflavor_idstring

OS flavor identifier

computer_descriptionstring

Computer description

user_name_transformstring

User name display value

processor_arch_name_transformstring

Processor architecture display value

no_of_processorsstring

Number of processors

domainstring

Domain name

computer_status_transformstring

Computer status display value

friendly_name_transformstring

Friendly name display value

computer_description_transformstring

Computer description display value

last_successful_scanstring

Last successful scan as epoch timestamp

computer_status_update_timestring

Status update time as epoch timestamp

no_of_processors_transformstring

Processors count display value

computer_statusstring

Computer status

branch_office_namestring

Branch office name

software_version_transformstring

Software version display value

processor_architecturestring

Processor architecture code

user_namestring

Installed user name

domain_netbios_namestring

Domain NetBIOS name

primary_owner_name_transformstring

Primary owner display value

user_component_idstring

User component identifier

fqdn_namestring

Fully qualified domain name

primary_owner_namestring

Primary owner name

software_idstring

Software identifier

ip_address_transformstring

IP address display value

boot_up_statestring

Boot up state

mac_addressstring

MAC address

architecturestring

Software architecture

boot_up_state_transformstring

Boot up state display value

domain_transformstring

Domain display value

friendly_namestring

Computer friendly name

last_successful_scan_transformstring

Last scan time display value

uninstall_status_transformstring

Uninstall status display value

last_sync_timestring

Last sync time as epoch timestamp

agent_logged_on_users_transformstring

Logged-on users display value

ip_addressstring

IP address

sw_familystring

Software family code

mac_address_transformstring

MAC address display value

servicetagstring

Service tag

total_ram_memorystring

Total RAM memory in bytes

resource_idstring

Resource identifier

os_namestring

Operating system name

locationstring

Installation location

computer_live_statusstring

Computer live status code

uninstall_statusstring

Uninstall status

resource_namestring

Computer resource name

customer_idstring

Customer identifier

is_usage_prohibitedstring

Prohibited status code

servicetag_transformstring

Service tag display value

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

Computers by prohibited software

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "resource_name_transform": "sample-computer",
        "model_transform": "Sample Model 7470",
        "installed_date_transform": "Mar 5, 2026",
        "architecture_transform": "32-bit",
        "uninstall_remarks": "--",
        "processor_arch_name": "x64-based PC",
        "uninstall_remarks_transform": "--",
        "sw_usage_type": "dc.common.NOT_KNOWN",
        "branch_office_id": "1",
        "model": "Sample Model 7470",
        "os_name_transform": "Windows 11 Professional Edition (x64)",
        "installed_date": "1772700015000",
        "software_name": "Sample Prohibited Software",
        "software_version": "1.0.0",
        "domain_netbios_name_transform": "WORKGROUP",
        "computer_resource_id": "301",
        "asset_tag": "-",
        "software_name_transform": "Sample Prohibited Software",
        "location_transform": "--",
        "branch_office_name_transform": "Local Office",
        "asset_tag_transform": "-",
        "os_platform": "1",
        "agent_logged_on_users": "SampleUser",
        "fqdn_name_transform": "sample-computer.example.com",
        "display_name": "Sample Prohibited Software",
        "osflavor_id": "0",
        "computer_description": "-",
        "user_name_transform": "--",
        "processor_arch_name_transform": "x64-based PC",
        "no_of_processors": "1",
        "domain": null,
        "computer_status_transform": "Unknown",
        "friendly_name_transform": "sample-computer",
        "computer_description_transform": "-",
        "last_successful_scan": "1778767527524",
        "computer_status_update_time": "1778767500267",
        "no_of_processors_transform": "1",
        "computer_status": "Unknown",
        "branch_office_name": "Local Office",
        "software_version_transform": "1.0.0",
        "processor_architecture": "2",
        "user_name": null,
        "domain_netbios_name": "WORKGROUP",
        "primary_owner_name_transform": "--",
        "user_component_id": null,
        "fqdn_name": "sample-computer.example.com",
        "primary_owner_name": "--",
        "software_id": "1",
        "ip_address_transform": "10.0.0.1",
        "boot_up_state": "Normal boot",
        "mac_address": "00:00:00:00:00:00",
        "architecture": "32-bit",
        "boot_up_state_transform": "Normal boot",
        "domain_transform": "--",
        "friendly_name": "sample-computer",
        "last_successful_scan_transform": "May 14, 2026 07:35 PM",
        "uninstall_status_transform": "--",
        "last_sync_time": "1778828070858",
        "agent_logged_on_users_transform": "SampleUser",
        "ip_address": "10.0.0.1",
        "sw_family": "1",
        "mac_address_transform": "00:00:00:00:00:00",
        "servicetag": "SAMPLE01",
        "total_ram_memory": "17179869184",
        "resource_id": "301",
        "os_name": "Windows 11 Professional Edition (x64)",
        "location": "--",
        "computer_live_status": "1",
        "uninstall_status": "--",
        "resource_name": "sample-computer",
        "customer_id": "1",
        "is_usage_prohibited": "2",
        "servicetag_transform": "SAMPLE01"
      }
    ],
    "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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.