Returns supported device types for a platform

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 supported device types for a given platform including bus type details.

Request URL

https://{server-hostname}:8383/dcapi/device/supportedDevices

Scope

DeviceControl.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/device/supportedDevices \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'
Show full

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

- 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

Possible Response Codes

200HTTP code
500HTTP code

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.