Returns supported device types for a platform

Returns the list of supported device types for a given platform including bus type details.

Endpoint

get /dcapi/device/supportedDevices

Copy full URL

Request URL

https://{serverurl}/dcapi/device/supportedDevices Copied!

Scope

DesktopCentralCloud.DeviceControl.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

- Query Parameters

platformIdintegerOptional

Target platform. 1 = Windows, 2 = Mac. Defaults to 0 (all platforms) when not specified

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomains/dcapi/device/supportedDevices \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'

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/device/supportedDevices"))
        .header("Content-Type", "application/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 = {
    'Content-Type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/dcapi/device/supportedDevices", headers=headers)

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

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


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/device/supportedDevices"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/device/supportedDevices' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

supportedDevicesJSON Array

List of supported device types

Show Sub-Attributes

JSON Object

Show Sub-Attributes

supportedDeviceIDstring

Supported device type identifier

deviceIDstring

Device type identifier

deviceNamestring

Device display name

statusCodeinteger

Device state/status code
1=Unblock,
2=Read Only,
3=Block,
4=No Change

priorityinteger

Display or processing priority

deviceCountstring

Count of matching devices

busTypesJSON Array

Supported bus types for the device

Show Sub-Attributes

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

supportedDeviceIDstring

Supported device type identifier

deviceIDstring

Device type identifier

deviceNamestring

Device display name

statusCodeinteger

Device state/status code
1=Unblock,
2=Read Only,
3=Block,
4=No Change

priorityinteger

Display or processing priority

deviceCountstring

Count of matching devices

busTypesJSON Array

Supported bus types for the device

Show Sub-Attributes

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

JSON Object

Show Sub-Attributes

supportedDeviceIDstring

Supported device type identifier

deviceIDstring

Device type identifier

deviceNamestring

Device display name

statusCodeinteger

Device state/status code
1=Unblock,
2=Read Only,
3=Block,
4=No Change

priorityinteger

Display or processing priority

deviceCountstring

Count of matching devices

busTypesJSON Array

Supported bus types for the device

Show Sub-Attributes

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

supportedDeviceIDstring

Supported device type identifier

deviceIDstring

Device type identifier

deviceNamestring

Device display name

statusCodeinteger

Device state/status code
1=Unblock,
2=Read Only,
3=Block,
4=No Change

priorityinteger

Display or processing priority

deviceCountstring

Count of matching devices

busTypesJSON Array

Supported bus types for the device

Show Sub-Attributes

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

JSON Object

Show Sub-Attributes

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

devToBusIDstring

Device-to-bus type relation identifier

supportedDeviceIDstring

Parent supported device type identifier

busTypeNamestring

Bus type name (e.g. USB, Bluetooth)

allowedboolean

Whether this bus type is currently allowed

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodestring

Error code identifying the type of error

errorMsgstring

Human-readable error message

Sample Response: HTTP 200

Supported devices response

Copied!

  {
    "supportedDevices": [
      {
        "deviceCount": "100",
        "supportedDeviceID": "1",
        "busTypes": [
          {
            "devToBusID": "1",
            "allowed": true,
            "supportedDeviceID": "1",
            "busTypeName": "USB"
          }
        ],
        "priority": 1,
        "deviceID": "10",
        "deviceName": "Removable Storage",
        "statusCode": 1
      }
    ]
  }

▼ Show full

Sample Response: HTTP 500

Internal server error

Copied!

  {
    "errorCode": "INTERNAL_ERROR",
    "errorMsg": "Internal Server Error!"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | 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.