AnnouncementsDocumentationDataplicity APICommunity projects
Dataplicity API

/devices/

List Devices

To get a detailed list of devices send a GET request to /devices/ endpoint.

http GET https://apps.dataplicity.com/devices/ 'Authorization: Token 123456789abcdefghijklmnopqrstuvwxyzqwer'

curl --header "Content-Type: application/json" -H "Authorization: Token 123456789abcdefghijklmnopqrstuvwxyzqwer" --request GET https://apps.dataplicity.com/devices/

The endpoint will return a 200 JSON response containing the following details for each device on the list:

{
        "agent_version": "0.4.34",
        "created_time": "2019-07-04T14:31:14.165418",
        "delete_permitted": true,
        "description": "",
        "diagnostics_permitted": true,
        "disk_capacity": 7401132032,
        "disk_used": 2934530048,
        "machine_manufacturer": "Sony UK",
        "machine_model": "4B",
        "machine_processor": "BCM2711",
        "machine_ram": "1024",
        "machine_revision": "1.1",
        "machine_type": "other_linux_device",
        "machine_type_display": "Other linux device",
        "machine_type_short_display": "Other Linux",
        "name": "Raspberry Pi 4",
        "online": true,
        "operating_system": "debian 10.0",
        "port_forwarding_permitted": true,
        "ports_url": "https://apps.dataplicity.com/devices/coff3efc-3cof-c0ff-f0cc-c0ff33c0ff33/ports/",
        "processor_speed": null,
        "ram_capacity": null,
        "reboot_url": "https://apps.dataplicity.com/devices/coff3efc-3cof-c0ff-f0cc-c0ff33c0ff33/reboot/",
        "serial": "coff3efc-3cof-c0ff-f0cc-c0ff33c0ff33",
        "tags": [
            {
                "name": "Rado's devices",
                "uid": "qwertyui-1234-1234-1234-12abcdefgijk"
            },
            {
                "name": "Raspberry Pi4",
                "uid": "asdfghji-5678-5678-5678-89xcvxvdzvzb"
            }
        ],
        "tools_permitted": true,
        "uname": "Linux raspberrypi 4.19.50-v7l+ #895 SMP Thu Jun 20 16:03:42 BST 2019 armv7l ",
        "upgrade_available": false,
        "url": "https://apps.dataplicity.com/devices/coff3efc-3cof-c0ff-f0cc-c0ff33c0ff33/",
        "wormhole_enabled": true,
        "wormhole_override": null,
        "wormhole_slug": "wormhole-example-1234",
        "wormhole_url": "https://wormhole-example-1234.dataplicity.io"
    },