Devices
Show
GET /devices/#{id}.format

Description

User can retrieve information from a specific device.
Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params
  2. device id (mandatory): device unique ID

Return example

Status:200

<device>
        <id>2636</id>
        <name>ComputerName</name>
        <alias>TestMachine</alias>
        <status>online</status>
        <ip>83.46.217.98</ip>
        <os>Windows 7</os>
        <last_refresh>2010-04-28T13:55:08Z</last_refresh>
        <cpu>Intel(R) Core(TM)2 Duo CPU T8100 @ 2.10GHz</cpu>
        <ram>2048.0</ram>
        <free_space>52.25% free of 149.05GB</free_space>
        <mac>00:0C:29:90:78:17</mac>
        <date_installed>2010-04-28T13:55:08Z</date_installed>
        <folder_id>12345</folder_id>
</device>
Response values

  1. id: unique device ID
  2. name: computer name
  3. alias: device alias
  4. status: device current status
    • offline
    • online
    • busy
  5. mac: device mac address
  6. ip: IP address of the device
  7. os: operating system of the device
    • Windows XP
    • Windows Vista
    • Windows 7
    • Windows Server 2008
    • Windows Server 2003
    • Windows NT
    • Linux
    • Mac OS X 10.5
    • Mac OS X 10.6
  8. last_refresh: last time this information was obtained
  9. cpu: cpu description
  10. ram: memory amount in MB
  11. free_space: percentage of free space and the total
  12. date_installed: date time which the agent was deployed in the device
  13. folder_id: folder identificador which the device belongs

Error Codes

  1. 1000 - Device not found (404)


List All
GET /devices.format
GET /folders/#{id} /devices.format


Description

User can obtain a list of his devices based on specific criteria.
The result of this call is a collection of devices. Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params
  2. folder id (optional): folder ID you want to filter. You can specify the folder id using the second request type from above. If this argument is omitted, by default it does not apply any filter and lists all devices. device id (mandatory): device unique ID

Response example

Status: 200

<devices>
        <device>
        
                …

        </device>
        <device>

        
                …

        </device>
</devices>
Error Codes

  1. 1100 - Folder id not found (404)


Update
PUT / devices/#{id}.format
PUT / folders/#{id}/devices/#{id}.format


Description

User can update device information. Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params
  2. device id (mandatory): device unique ID
  3. alias (optional): devices alias
  4. folder id (optional): folder ID where you want to update a device. You can specify the folder id using the second request type from above

Request example

<device>
        <alias>UpdatedName</alias>
        <folder_id>123</folder_id>
</device>
Note: You can submit the folder id in the URI using the second request type from above or as shown in the request body example. If both methods are used at the same time the information submitted in the URI will have more priority.If you do not submit a folder, the device does not get unassigned from its folder. If you submit an empty folder tag, the device gets unassigned from any folder.
<device>
        <alias>UpdatedName</alias>
        <folder_id></folder_id>
</device>
Response example

Status:200
Error Codes

  1. 1000 - Device id not found (404)
  2. 1001 - Read only parameter (403)
  3. 1100 - Folder id not found (404)