Get Device Rules

GET {{baseUrl}}/web/api/v2.1/device-control?ruleName=ex&deviceClasses=ex&createdAt__lt=ex&skip=ex&sortOrder=ex&createdAt__lte=ex&gattServices=ex&statuses=ex&ids=ex&deviceNames=ex&accessPermissions=ex&vendorIds=ex&manufacturerNames=ex&bluetoothAddresses=ex&interfaces=ex&uids=ex&disablePagination=ex&createdAt__gte=ex&minorClasses=ex&siteIds=ex&sortBy=ex&groupIds=ex&limit=ex&query=ex&accountIds=ex&cursor=ex&createdAt__between=ex&tenant=ex&skipCount=ex&scopes=ex&actions=ex&productIds=ex&deviceInformationServiceInfoKeys=ex&serviceClasses=ex&countOnly=ex&createdAt__gt=ex&versions=ex

Get the Device Control rules of a specified Account, Site, Group or Global (tenant) that match the filter.

Request Params

Key	Datatype	Description
`ruleName`	string	Return device rules with the filtered rule name.
`deviceClasses`	string	Return device rules with the filtered device class. Example: "02h".
`createdAt__lt`	string	Return device rules created before this timestamp. Example: "2018-02-27T04:49:26.257525Z".
`skip`	string	Skip first number of items (0-1000). To iterate over more than 1000 items, use "cursor". Example: "150".
`sortOrder`	string	Sort direction. Example: "asc".
`createdAt__lte`	string	Return device rules created before or at this timestamp. Example: "2018-02-27T04:49:26.257525Z".
`gattServices`	string	Return device rules with the filtered GATT services.
`statuses`	string	Return device rules with the filtered status. Example: "Enabled".
`ids`	string	List of ids to filter by. Example: "225494730938493804,225494730938493915".
`deviceNames`	string	Return device rules with the filtered device names.
`accessPermissions`	string	Access permission in. Example: "Read-Only".
`vendorIds`	string	Return device rules with the filtered vendor id.
`manufacturerNames`	string	Return device rules with the filtered manufacturer names.
`bluetoothAddresses`	string	Return device rules with the filtered bluetooth addresses.
`interfaces`	string	Return device rules with the filtered interface. Example: "USB".
`uids`	string	Return device rules with the filtered uId.
`disablePagination`	string	If true, all rules for requested scope will be returned
`createdAt__gte`	string	Return device rules created after or at this timestamp. Example: "2018-02-27T04:49:26.257525Z".
`minorClasses`	string	Return device rules with the filtered minor classes.
`siteIds`	string	List of Site IDs to filter by. Example: "225494730938493804,225494730938493915".
`sortBy`	string	The column to sort the results by. Example: "id".
`groupIds`	string	List of Group IDs to filter by. Example: "225494730938493804,225494730938493915".
`limit`	string	Limit number of returned items (1-1000). Example: "10".
`query`	string	A free-text search term, will match applicable attributes.
`accountIds`	string	List of Account IDs to filter by. Example: "225494730938493804,225494730938493915".
`cursor`	string	Cursor position returned by the last request. Use to iterate over more than 1000 items. Example: "YWdlbnRfaWQ6NTgwMjkzODE=".
`createdAt__between`	string	Return device rules created within this range (inclusive). Example: "1514978764288-1514978999999".
`tenant`	string	Indicates a Global (tenant) scope request
`skipCount`	string	If true, total number of items will not be calculated, which speeds up execution time.
`scopes`	string	Return only device rules in this scope. Example: "group".
`actions`	string	Return device rules with the filtered action. Example: "Allow".
`productIds`	string	Return device rules with the filtered product id. Example: "02".
`deviceInformationServiceInfoKeys`	string	Return device rules with the filtered device information service info keys.
`serviceClasses`	string	Return device rules with the filtered service class. Example: "02".
`countOnly`	string	If true, only total number of items will be returned, without any of the actual objects.
`createdAt__gt`	string	Return device rules created after this timestamp. Example: "2018-02-27T04:49:26.257525Z".
`versions`	string	Return device rules with the filtered versions.

HEADERS

Key	Datatype	Required	Description
`Content-Type`	null