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

application/json

Body

required

location

object

nullable

alt stringnullable

lat stringrequired

long stringrequired
name stringnullable

Device name

Responses

200

application/json

Schema

Schema

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)

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

Example (from schema)

{
  "battery": {
    "health": 0,
    "isPluggedIn": true,
    "isVirtual": true,
    "level": 0,
    "state": "string",
    "timeRemainingMinutes": 0
  },
  "location": {
    "alt": "string",
    "lat": "string",
    "long": "string"
  },
  "macAddress": "string",
  "name": "string",
  "os": "string",
  "osRelease": "string",
  "storageAvailable": 0,
  "urlGetAppServerActive": "string"
}

Loading...