Get Registered Devices

GET 
/api/v2/device/devices

This service message allows retrieval of all registered devices as a paginated result. Pagination is controlled via page/perPage (defaults are applied when omitted). When a rule is supplied — either a saved ruleId or an inline dynamic rule (JSON string) — only devices matching that rule are returned (pagination is applied after filtering).

Request

Query Parameters

page number

Page number (1-based). Defaults to 1 when omitted.

perPage number

Number of items per page. Defaults to 100 when omitted.

ruleId string

When provided, only devices matching this saved rule are returned. Pagination is applied to the filtered list.

rule string

Inline rule as a JSON string (rule-engine format). When provided, only devices matching this dynamic rule are returned. Ignored when ruleId is supplied.

groups string[]

Array of groups IDs or a single group ID

Header Parameters

Device-Auth any

Responses

200

A paginated result of devices.

application/json

Schema

Schema

data

object[]

required

The data items for the current page

Array [

id stringrequired

lastUpdatedDate date-time

lastConnectionDate date-time

name string

OS string

availableStorage string

power number

bandwidth number

operativeState boolean

state string

Possible values: [online, active, offline, disconnected]

Connectivity state, computed at read-time: online > active > offline > disconnected.

status string[]

Possible values: [updating, error, restricted]

Operational conditions; a device may have several at once (updating/error/restricted).

online boolean

True when the device currently holds an open reactive (managed-command) SSE channel.

metaData object

groupName string

groupId number

uid string

formations string[]

platformName string

platformTypeName string

The device's platform type name (server-derived from the platform_type catalog).

deviceTypeName string

devices string[]

platformId string

Platform instance id reported by the agent.

]

total numberrequired

The total number of items available

page numberrequired

The current page number

perPage numberrequired

The number of items per page

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "lastUpdatedDate": "2026-11-08T13:48:42.459Z",
      "lastConnectionDate": "2026-11-08T13:48:42.459Z",
      "name": "string",
      "OS": "string",
      "availableStorage": "string",
      "power": 0,
      "bandwidth": 0,
      "operativeState": true,
      "state": "online",
      "status": [
        "updating"
      ],
      "online": true,
      "metaData": {},
      "groupName": "string",
      "groupId": 0,
      "uid": "string",
      "formations": [
        "string"
      ],
      "platformName": "string",
      "platformTypeName": "string",
      "deviceTypeName": "string",
      "devices": [
        "string"
      ],
      "platformId": "string"
    }
  ],
  "total": 100,
  "page": 1,
  "perPage": 10
}

Loading...