HubDevices

Retrieves the list of hub installed driver

Changed on

Returns the list of drivers currently installed on the hub

get/hubdevices/{hubDeviceId}/drivers

Request

Path parameters

hubDeviceIdstring ^(?:([0-9a-fA-F]{32})|([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}))$ required

The Hub's Device ID. This is sometimes referred to as the Hub UUID or HubId

Query parameters

deviceIdstring

optional filter to only return installed drivers that can be used by the passed in device

Headers

Authorizationstring string required

OAuth token

Accept-Languagestring

Language header representing the client's preferred language. The format of the Accept-Language header follows what is defined in RFC 7231, section 5.3.5

Response

List of hub installed drivers

driverIdstring required

Unique Identifier of the driver

namestring required

User friendly Identifier for Driver

descriptionstring

Description of Driver

versionstring required

version of the driver currently in use

channelIdstring

identifier for channel this driver is installed from

developerstring

developer of the driver

vendorSupportInformationstring

information on how to reach vendor

permissionsobject

map of permissions and attributes used by the driver. In format of {"permissions":{"perm1":{...}, "perm2"{...}}}

isWWSTboolean

Flag to denote that this driver is part of a works with SmartThings channel

Example response

[
  {
    "driverId": "6d7bf35a-bb57-4b1f-945a-63ff72bfbef3",
    "name": "Caleb's Fiendly Driver",
    "description": "One friendly driver alright",
    "vendorSupportInformation": "You can find us at JustAFriendlyDriver.com",
    "permissions": {
      "lan": {},
      "lan_internet": {
        "allowed_hosts": [
          "smartthings.com",
          "samsung.com"
        ]
      }
    }
  }
]

Changes