Get Device

Get device

curl --request GET \
  --url https://managexrapi.com/v1/devices/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": {
    "id": "12345678901234",
    "serial": "12345678901234",
    "name": "Training Room 1",
    "mac": "CE:AF:07:47:E0:AE",
    "model": "Quest 2",
    "manufacturer": "Meta",
    "notes": "Mounted in Room 5",
    "batteryLevel": 87,
    "batteryIsCharging": true,
    "pauseUpdates": false,
    "online": true,
    "osVersion": "Android 12",
    "outOfDate": true,
    "registerDate": "2023-11-12T10:30:00Z",
    "updating": false,
    "factoryResetStatus": "NONE",
    "firmwareVersion": "Oculus OS 46.0.0.230",
    "configuration": {
      "id": "sFidGmedeQofSBcvRcyn",
      "name": "Training Configuration"
    },
    "tags": [
      {
        "id": "tag_abc123",
        "name": "Lab Devices"
      }
    ],
    "tutorialModeEnabled": false,
    "kioskModeOverride": true,
    "lastSync": "2024-04-20T17:23:12Z",
    "ram": {
      "available": 2147483648,
      "total": 4294967296
    },
    "storage": {
      "available": 15728640000
    },
    "location": {
      "city": "San Francisco",
      "region": "California",
      "country": "US",
      "continent": "North America",
      "timeZone": "America/Los_Angeles",
      "longitude": -122.4194,
      "latitude": 37.7749
    },
    "connectedWifiNetwork": {
      "ssid": "ManageXR-Office"
    },
    "currentForegroundApp": {
      "packageName": "com.my.app",
      "title": "My Training App"
    },
    "controllerData": {
      "controller0": {
        "batteryLevel": 85,
        "version": "v14"
      },
      "controller1": {
        "batteryLevel": 82,
        "version": "v14"
      }
    }
  }
}

GET

devices

{id}

Get device

curl --request GET \
  --url https://managexrapi.com/v1/devices/{id} \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": {
    "id": "12345678901234",
    "serial": "12345678901234",
    "name": "Training Room 1",
    "mac": "CE:AF:07:47:E0:AE",
    "model": "Quest 2",
    "manufacturer": "Meta",
    "notes": "Mounted in Room 5",
    "batteryLevel": 87,
    "batteryIsCharging": true,
    "pauseUpdates": false,
    "online": true,
    "osVersion": "Android 12",
    "outOfDate": true,
    "registerDate": "2023-11-12T10:30:00Z",
    "updating": false,
    "factoryResetStatus": "NONE",
    "firmwareVersion": "Oculus OS 46.0.0.230",
    "configuration": {
      "id": "sFidGmedeQofSBcvRcyn",
      "name": "Training Configuration"
    },
    "tags": [
      {
        "id": "tag_abc123",
        "name": "Lab Devices"
      }
    ],
    "tutorialModeEnabled": false,
    "kioskModeOverride": true,
    "lastSync": "2024-04-20T17:23:12Z",
    "ram": {
      "available": 2147483648,
      "total": 4294967296
    },
    "storage": {
      "available": 15728640000
    },
    "location": {
      "city": "San Francisco",
      "region": "California",
      "country": "US",
      "continent": "North America",
      "timeZone": "America/Los_Angeles",
      "longitude": -122.4194,
      "latitude": 37.7749
    },
    "connectedWifiNetwork": {
      "ssid": "ManageXR-Office"
    },
    "currentForegroundApp": {
      "packageName": "com.my.app",
      "title": "My Training App"
    },
    "controllerData": {
      "controller0": {
        "batteryLevel": 85,
        "version": "v14"
      },
      "controller1": {
        "batteryLevel": 82,
        "version": "v14"
      }
    }
  }
}

Authorizations

Authorization

string

header

required

API key based authentication where is the Base64 encoding of API_KEY_ID:API_KEY_SECRET

Username: The API Key ID.
Password: The API Key Secret.

Path Parameters

string

required

Unique identifier (serial number) of the device

Query Parameters

organizationId

string

Unique identifier of the organization. Defaults to the organization associated with the API key if no id supplied.

Response

A device object

data

object

Full representation of a device managed in ManageXR

Show child attributes

data.id

string

The device ID (serial number)

Example:

"12345678901234"

data.serial

string

Device serial number

Example:

"12345678901234"

data.name

string

The device name

Example:

"Training Room 1"

data.mac

string

MAC address of the device

Example:

"CE:AF:07:47:E0:AE"

data.model

string

The device model

Example:

"Quest 2"

data.manufacturer

string

The device manufacturer

Example:

"Meta"

data.notes

string

Optional user-provided notes about the device

Example:

"Mounted in Room 5"

data.batteryLevel

number

Battery level percentage

Example:

87

data.batteryIsCharging

boolean

Whether the device is currently charging

Example:

true

data.pauseUpdates

boolean

Whether updates are paused for this device

Example:

false

data.online

boolean

Whether the device is currently online

Example:

true

data.osVersion

string

The OS version running on the device

Example:

"Android 12"

data.outOfDate

boolean

Whether the device is running outdated software

Example:

true

data.registerDate

string<date-time>

The date this device was registered with ManageXR

Example:

"2023-11-12T10:30:00Z"

data.updating

boolean

Whether the device is currently performing an update

Example:

false

data.factoryResetStatus

string

Status of any pending or active factory reset

Example:

"NONE"

data.firmwareVersion

string

Firmware version reported by the device

Example:

"Oculus OS 46.0.0.230"

data.configuration

object

The configuration assigned to this device

Show child attributes

data.configuration.id

string

Example:

"sFidGmedeQofSBcvRcyn"

data.configuration.name

string

Example:

"Training Configuration"

data.tags

object[]

Tags assigned to this device

Show child attributes

data.tags.id

string

Example:

"tag_abc123"

data.tags.name

string

Example:

"Lab Devices"

data.tutorialModeEnabled

boolean

Whether tutorial mode is enabled

Example:

false

data.kioskModeOverride

boolean

True if device has Kiosk Mode/ManageXR Home Screen disabled. When true, the device is not locked into the ManageXR Home Screen or Kiosk App and users have full access to the native system menus. Learn more

Example:

true

data.lastSync

string<date-time>

The last time the device checked in with ManageXR. Online devices check in every 15 minutes.

Example:

"2024-04-20T17:23:12Z"

data.ram

object

RAM usage info

Show child attributes

data.ram.available

number

Available RAM in bytes

Example:

2147483648

data.ram.total

number

Total RAM in bytes

Example:

4294967296

data.storage

object

Internal storage usage info

Show child attributes

data.storage.available

number

Available storage in bytes

Example:

15728640000

data.location

object

Approximate location of the device

Show child attributes

data.location.city

string

Example:

"San Francisco"

data.location.region

string

Example:

"California"

data.location.country

string

Example:

"US"

data.location.continent

string

Example:

"North America"

data.location.timeZone

string

Example:

"America/Los_Angeles"

data.location.longitude

number

Example:

-122.4194

data.location.latitude

number

Example:

37.7749

data.connectedWifiNetwork

object

Current connected Wi-Fi network

Show child attributes

data.connectedWifiNetwork.ssid

string

Example:

"ManageXR-Office"

data.currentForegroundApp

object

Currently running app in the foreground

Show child attributes

data.currentForegroundApp.packageName

string

Example:

"com.my.app"

data.currentForegroundApp.title

string

Example:

"My Training App"

data.controllerData

object

Data about connected controllers

Show child attributes

data.controllerData.controller0

object

Show child attributes

data.controllerData.controller0.batteryLevel

number

Example:

85

data.controllerData.controller0.version

string

Example:

"v14"

data.controllerData.controller1

object

Show child attributes

data.controllerData.controller1.batteryLevel

number

Example:

82

data.controllerData.controller1.version

string

Example:

"v14"

List Devices Edit Device

⌘I

Getting Started

Devices

Configurations

Apps

App Versions & Release Channels

Library

Tags

Organizations

Authorizations

Path Parameters

Query Parameters

Response