Skip to main content

Update device metadata

PUT 
/api/v2/device/metadata

Updates device metadata including name, location, and custom fields. Use null values in misc object to delete specific custom fields.

Request​

Body

required

    location

    object

    nullable

    alt stringnullable
    lat stringrequired
    long stringrequired
    name stringnullable

    Device name

Responses​

Schema

    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

Loading...