Update an existing device

This action will update an existing device matching the given UUID.

Try this request in your browser

/api/ /devices/update

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

uuid String
mac_address String
description String
device_type String
additional_config String
auth_key String
extension_id Integer 

The request output will be shown here...

URL

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

Access

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

Parameters

Parameter Type Default

uuid Required

The UUID of the device

 String null

mac_address Required

The MAC address of the device

 String null

description Required

The description of the device

 String null

device_type Required

The device type

 String null

additional_config

Any additional configuration for the device

 String null

auth_key

The administration password for the device

 String null

extension_id Required

The id of the extension for this device

 Integer null

Errors

Error Attributes

DeviceNotFound

No device was found given the UUID provided

  • uuid

    The provided UUID

NoAccessToDevice

Your authenticated identity is not permitted to access this device

InvalidExtension

The extension provided was invalid

  • id

    The id that was looked up

ValidationError

A validation error occurred

  • errors

    An array of errors

Response Data

This action will return a device structure.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive all expansions for this stucture.