Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Devices

List devices

get/v1/device

Query parameters

offsetinteger

Starting index for pagination

limitinteger

Number of items to return for pagination

sort_by'hostname'

Sort by a specific field

sort_ascboolean

Sort in ascending order

client_idstring

ID of a client

Example:c_0123456789ab
created_afterstring date-time

Filter results to after a specific creation timestamp (RFC3339 format)

created_beforestring date-time

Filter results to before a specific creation timestamp (RFC3339 format)

Response

OK

Example response

{
  "data": [
    {
      "addresses": [
        {
          "ips": [
            "192.168.1.104"
          ],
          "mac": "62:bb:d3:0d:db:7d"
        }
      ],
      "booted_at": "2024-08-23T01:25:08Z",
      "client_id": "c_0123456789ab",
      "device_id": "d_0123456789ab",
      "device_warranty_expiration_date": "2029-08-23T01:25:08Z",
      "display_name": "My First Device",
      "hardware_model_name": "Slide Z1, 1 TB",
      "hostname": "my-hostname-1",
      "image_version": "1.0.0",
      "ip_addresses": [
        "192.168.3.53"
      ],
      "last_seen_at": "2024-08-23T01:25:08Z",
      "package_version": "1.2.3",
      "public_ip_address": "74.83.124.111",
      "serial_number": "SN123456",
      "service_model_name": "Slide Z1 Subscription, 1 TB, 1 Year Cloud Retention",
      "service_model_name_short": "1 Year Cloud Retention",
      "service_status": "active",
      "storage_total_bytes": 1099511627776,
      "storage_used_bytes": 274877906944,
      "total_agent_included_volume_used_bytes": 274877906944
    }
  ],
  "pagination": {
    "next_offset": 10
  }
}