Skip to main content

Get device data for CDN-connected devices

GET 
/api/cdn/device

Returns DeviceDataV2 per device. By default returns only active devices (the whitelist). Use ?filter=inactive or ?filter=all to widen the result.

Request​

Query Parameters

    device_id string[]

    Repeated device ID filter: ?device_id=id1&device_id=id2. Omit to return all.

    filter string

    Active-state filter: 'active' (default — whitelist), 'inactive', or 'all'.

Responses​

DeviceDataV2 for each CDN-connected device (active only by default).

Schema

  • Array [

    • data

    object

    Device - Enrollment: Device connection and authentication configurations

    deliverySource DeliverySourcerequired

    Possible values: [cache, remote]

    deviceId stringrequired

    Device identifier

    deviceType string[]required

    Device type tokens

    platform stringnullable

    Platform name

    platformId stringnullable

    Platform identifier

    urlGetAppServerAvailable string[]nullable

    Available GetApp server URLs

    metadata

    object

    nullable

    required

    Device - MetaData: Physical and logical device properties

    battery

    object

    nullable

    Comprehensive battery status information

    health int32nullable

    Battery health as a percentage (0-100), based on current capacity vs design capacity

    isPluggedIn booleannullable

    Whether the device is plugged into power (charging or full)

    isVirtual booleannullable

    Whether this is a virtual/emulated battery (e.g., in VM)

    level int32required

    Battery level as a percentage (0-100)

    state stringrequired

    Battery state description (Charging, Discharging, Full, Empty, Unknown)

    timeRemainingMinutes int32nullable

    Estimated time remaining in minutes (for discharge or charge)

    ipAddress stringnullable

    IP address

    location

    object

    nullable

    alt stringnullable
    lat stringrequired
    long stringrequired
    macAddress stringnullable

    MAC address

    name stringnullable

    Device name

    os stringnullable

    Operating system

    osRelease stringnullable

    OS release version

    storageAvailable int64nullable

    Available storage in bytes

    urlGetAppServerActive stringrequired

    Currently active GetApp server URL

    deviceId stringrequired

    Device identifier — matches the deviceId in CDN discovery.

    isMaster booleanrequired

    true when this entry represents the local CDN master agent itself.

  • ]

Loading...