List all devices

This action will return a list of all devices configured in the given unit.

Try this request in your browser

/api/ /devices/list

Headers

X-Auth-App
X-Auth-Token
X-Auth-Secret
X-Auth-Extension
X-Auth-Password
X-Proxy-Auth-Token
X-Proxy-Auth-Secret

Parameters

unit_id Integer
page Integer
per_page Integer
sort_by String
order String
filters Hash

Structures

Include extended attributes? 

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/devices/list

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter Type Default

unit_id

The ID of the unit

 Integer null

page

The page number

 Integer 1

per_page

The number of items to return per page

 Integer 30

sort_by

The field to sort by

 String description

order

The direction to order units by

 String asc

filters

A hash of filters to apply to results

 Hash {}

Filtering

This action supports filtering. You can filter the results which you receive by providing filters in the filters parameter. The following attributes are supported for filtering.

Attribute Supported Operators
description eq, not_eq, starts_with, ends_with, in, not_in
mac_address eq, not_eq, starts_with, ends_with, in, not_in
ip_address eq, not_eq, starts_with, ends_with, in, not_in
device_type eq, not_eq, starts_with, ends_with, in, not_in

Errors

Error Attributes

UnitNotFound

The given unit was not found

  • id

    The provided ID

FilterError

An error has occurred while processing filters for this action

  • issue_code

    A more specific issue code

  • issue_message

    A more specific message about the issue

Response Data

This action will return an array of device structures.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. No expansions will be provided.