List Devices

6min
Show all devices the requesting manager has access permissions to.
URL: /api/v1/devices/
Method: GET
Query Parameters:
Ordering:
order_by - Which attribute to order the list by.
default ordering is ascending, can be made descending by prefixing the attribute name with -
Example: order_by=created_at
Example: order_by=-created_at
Pagination:
Default pagination is 20 results per page.
limit - Number of results to return per page.
Example: limit=20
offset - The initial index from which to return the results.
Example: offset=21
Filtering:
The results can be filtered by various attributes on device or related to the device.
Possible filters:
license
blacklisted
hostname
hardware_id
Success Response:
Code: 200 OK
Content Examples:
JSON
|
{
    "count": 10,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1590981949868340,
            "device_variables": [],
            "created_at": "2020-06-02T10:32:54Z",
            "updated_at": "2020-06-02T12:35:17Z",
            "hardware_id": "1C0B-D53D-2A92-9665-9634-1FE5-1326-56DF-5401-63B1-88D5-DB7D-FB02-D440-3760-720D",
            "time_activated": "2020-03-11T10:22:29Z",
            "time_deactivated": null,
            "validity_period": null,
            "device_active": true,
            "type": "desktop",
            "os": "Microsoft Home 10",
            "sdk_build_version": "Java SDK 0.0.1",
            "last_check": "2020-03-13T11:04:45Z",
            "app_ver": "1.0.",
            "hostname": "DESKTOP-2K64QES",
            "ip": "192.168.202.1",
            "external_ip": "46.234.71.160",
            "mac_address": null,
            "is_vm": true,
            "vm_info": "VMware ESX 3",
            "floating_last_seen": null,
            "floating_in_use": false,
            "blacklisted": false,
            "license": {
                "id": 1606461720853199,
                "license_key": null
            }
        },
        ...
    ]
}
{
    "count": 10,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1590981949868340,
            "device_variables": [],
            "created_at": "2020-06-02T10:32:54Z",
            "updated_at": "2020-06-02T12:35:17Z",
            "hardware_id": "1C0B-D53D-2A92-9665-9634-1FE5-1326-56DF-5401-63B1-88D5-DB7D-FB02-D440-3760-720D",
            "time_activated": "2020-03-11T10:22:29Z",
            "time_deactivated": null,
            "validity_period": null,
            "device_active": true,
            "type": "desktop",
            "os": "Microsoft Home 10",
            "sdk_build_version": "Java SDK 0.0.1",
            "last_check": "2020-03-13T11:04:45Z",
            "app_ver": "1.0.",
            "hostname": "DESKTOP-2K64QES",
            "ip": "192.168.202.1",
            "external_ip": "46.234.71.160",
            "mac_address": null,
            "is_vm": true,
            "vm_info": "VMware ESX 3",
            "floating_last_seen": null,
            "floating_in_use": false,
            "blacklisted": false,
            "license": {
                "id": 1606461720853199,
                "license_key": null
            }
        },
        ...
    ]
}
﻿
﻿
Updated 05 Sep 2023
Did this page help you?
Count License Transfers
Retrieve Device
Docs powered by
Archbee
TABLE OF CONTENTS