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. Use ?device_status=inactive or ?device_status=all to widen by enrollment state. Use ?device_mode=orchestrated, ?device_mode=reactive, or ?device_mode=both to filter by device flags. When ?device_mode= is set, add ?device_connectivity=online or ?device_connectivity=offline to further filter by heartbeat TTL.

Request​

Query Parameters

    device_id string[]

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

    device_status any

    Device status filter: active (default), inactive, or all.

    device_mode any

    Device mode filter: orchestrated (ORCHESTRATE_ME flag), reactive (REACTIVE_MODE flag), or both. Omit for no mode filter.

    device_connectivity any

    Device connectivity filter (only applied when ?device_mode= is set): online (active SSE subscription on ManagedCommand channel), offline (not subscribed), or both.

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

    orchestrateMe booleannullable

    When true, requests that a master agent orchestrate this device.

    orchestratedBy stringnullable

    Master device-id that is currently orchestrating this device, if any.

    platform stringnullable

    Platform name

    platformId stringnullable

    Platform identifier

    reactiveMode booleannullable

    When true, the device subscribes to the master SSE command channel.

    urlGetAppServerAvailable string[]nullable

    Available GetApp server URLs

    metadata

    object

    nullable

    required

    Device - MetaData: Physical and logical device properties

    bandwidth

    object

    nullable

    A single bandwidth measurement result.

    connectionType stringnullable
    downloadKbps int32nullable
    measuredAt stringnullable
    uploadKbps int32nullable

    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 stringdeprecated

    Currently active GetApp server URL. Deprecated for local v2 consumers — read from GET /agent/status instead. Still authoritative in the CDN per-device snapshot, where no per-device status endpoint exists (mirrors versions).

    versions

    object

    nullable

    Installed software versions reported by the device.

    agent stringnullable

    GetApp agent version

    agentUi stringnullable

    GetApp agent-UI version

    metadataUpdatedAt objectnullable

    Per-field last-changed timestamps (ISO-8601 UTC), grouped by field group as { group: { field: ISO-8601 } }, where group is one of metadata or enrollment. Populated from the device_metadata ledger.

    snapshotDate date-timenullable

    Last snapshot timestamp (UTC)

    dataWarning stringnullable

    Warning message indicating the data field may be incomplete or unreliable. When present, surface it visibly to the user.

    deviceId stringrequired

    Device identifier — matches the deviceId in CDN discovery.

    isMaster booleanrequired

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

    isOnline booleanrequired

    true when the device has an active SSE subscription on the ManagedCommand channel.

  • ]

Loading...