ManageXR Developer Tools

https://docs.managexr.com
Admin
Take advantage of ManageXR developer tools to automate workflows, simplify device management, and...
Tokens:33,208
Snippets:206
Trust Score:8.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example: Install Specific SDK Version

Source: https://docs.managexr.com/3d-environment-sdk-reference/setup

Example of how to specify a particular SDK version, such as v0.2.0, in your manifest.json.

```json
"com.mxr.mxrus.sdk":"https://www.github.com/ManageXR/mxrus-sdk.git#v0.2.0"
```

--------------------------------

### Duplicate App Version with Bundled Files

Source: https://docs.managexr.com/cli-reference/command/duplicate-app

This example shows how to duplicate an app version and include bundled files. The `--bundle-directory` flag specifies the local path to the files, and an optional path on the device can be provided for installation.

```bash
mxr-cli duplicate-app-version com.myapp.quest 42 "4.2.0" "Stable" --bundle-directory /path/to/directory /path/on/device --api-key-file /path/to/api_key.json
```

--------------------------------

### Install ManageXR CLI using NPM

Source: https://docs.managexr.com/cli-reference/introduction

Install the ManageXR CLI globally on your system using NPM. This command makes the `mxr-cli` available in your terminal.

```bash
npm install -g @managexr/mxr-cli
```

--------------------------------

### Launch WebXR Link Example

Source: https://docs.managexr.com/api-reference/endpoint/batch-commands

Use this command to launch a WebXR link on the specified devices. The URL must be a valid web address.

```json
{
  "deviceIds": [
    "fJlJrjEL08UkhSLRRryd",
    "GrCQfwI4373WFqzVjguI"
  ],
  "action": "LAUNCH_WEB_URL",
  "data": {
    "url": "https://google.com"
  }
}
```

--------------------------------

### Launch App Command Example

Source: https://docs.managexr.com/api-reference/endpoint/send-command

Use this snippet to launch a specific application on a device. Ensure the packageName corresponds to the app you wish to launch.

```json
{
  "action": "LAUNCH_APP",
  "data": {
    "packageName": "com.example.app"
  }
}
```

--------------------------------

### Install ManageXR React Streaming SDK

Source: https://docs.managexr.com/streaming-sdk-reference/introduction

Install the ManageXR React Streaming SDK using npm. This package enables embedding device streaming into React applications.

```bash
npm i @managexr/react-streaming
```

--------------------------------

### Launch WebXR Link Example

Source: https://docs.managexr.com/api-reference/endpoint/send-command

Use this snippet to open a web URL on the device. This is useful for launching web-based applications or specific web content.

```json
{
  "action": "LAUNCH_WEB_URL",
  "data": {
    "url": "https://google.com"
  }
}
```

--------------------------------

### Sync Command Example

Source: https://docs.managexr.com/api-reference/endpoint/send-command

Use this snippet to force a device to check in with ManageXR. Online devices sync automatically every 15 minutes or immediately after configuration changes.

```json
{
  "action": "SYNC"
}
```

--------------------------------

### Get Configuration

Source: https://docs.managexr.com/llms.txt

Retrieve a configuration by id.

```APIDOC
## GET /v1/get-configuration/{configurationId}

### Description
Retrieve a configuration by id.

### Method
GET

### Endpoint
/v1/get-configuration/{configurationId}

### Parameters
#### Path Parameters
- **configurationId** (string) - Required - The ID of the configuration to retrieve.

### Response
#### Success Response (200)
- **configuration** (object) - The requested configuration.
  - **id** (string) - The ID of the configuration.
  - **name** (string) - The name of the configuration.
  - **content** (object) - The content of the configuration.

#### Response Example
{
  "configuration": {
    "id": "config_789",
    "name": "Default Configuration",
    "content": {
      "apps": [
        {
          "appId": "app_123",
          "versionId": "version_abc"
        }
      ]
    }
  }
}
```

--------------------------------

### Get App

Source: https://docs.managexr.com/llms.txt

Returns information about a specific app including the title, iconUrl, categories, and number of versions.

```APIDOC
## GET /v1/get-app/{appId}

### Description
Returns information about a specific app including the title, iconUrl, categories, and number of versions.

### Method
GET

### Endpoint
/v1/get-app/{appId}

### Parameters
#### Path Parameters
- **appId** (string) - Required - The ID of the app to retrieve.

### Response
#### Success Response (200)
- **app** (object) - Information about the app.
  - **id** (string) - The ID of the app.
  - **title** (string) - The title of the app.
  - **description** (string) - The description of the app.
  - **iconUrl** (string) - The URL of the app's icon.
  - **categories** (array) - The categories of the app.
  - **numberOfVersions** (integer) - The number of versions available for this app.

#### Response Example
{
  "app": {
    "id": "app_456",
    "title": "My Self-Hosted App",
    "description": "An example of a self-hosted application.",
    "iconUrl": "https://example.com/icons/my-app.png",
    "categories": ["productivity", "utility"],
    "numberOfVersions": 5
  }
}
```

--------------------------------

### Launch App with Parameters Example

Source: https://docs.managexr.com/api-reference/endpoint/send-command

Use this snippet to launch an application with specific parameters. This allows for customized app launches, including user IDs, boolean flags, float values, arrays, and key-value maps.

```json
{
  "action": "LAUNCH_APP",
  "data": {
    "packageName": "com.example.app",
    "launchParams": {
      "userId": "AX3EIUf89",
      "booleanValue": true,
      "floatValue": 100.29,
      "arrayValue": [
        1.23,
        4.56
      ],
      "mapValue": {
        "key": "value"
      }
    }
  }
}
```

--------------------------------

### Upload App, OBB, Set Title/Description, and Publish to Release Channel

Source: https://docs.managexr.com/cli-reference/command/upload-app

This example demonstrates uploading an APK and its OBB file, setting a custom title and description for the app, and publishing it to a specified release channel using API key file authentication.

```bash
mxr-cli upload-app /path/to/apkfile.apk --obb-file  /path/to/obbfile.obb --title "Cool new app" --description "This app is amazing" --release-channel "Dev" --api-key-file /path/to/api_key.json
```

--------------------------------

### Run ManageXR CLI commands

Source: https://docs.managexr.com/cli-reference/introduction

Execute ManageXR CLI commands after installation. Replace `<command>` with the desired CLI action and `[options]` with any necessary arguments.

```bash
mxr-cli <command> [options]
```

--------------------------------

### Get App Configuration

Source: https://docs.managexr.com/api-reference/endpoint/get-configuration

Fetches the configuration details for a specific app, including settings for videos, permissions, and expiration.

```APIDOC
## GET /apps/{appId}/configuration

### Description
Retrieves the configuration for a specific app, including details about deployed videos and app settings.

### Method
GET

### Endpoint
/apps/{appId}/configuration

### Parameters
#### Query Parameters
- **appId** (string) - Required - The unique identifier of the app.

### Response
#### Success Response (200)
- **apps** (array) - List of app configurations.
  - **videos** (array) - List of videos deployed with the configuration.
    - **id** (string) - Unique identifier of the video.
    - **title** (string) - Title of the video.
    - **videoType** (string) - Type of the video (_360, _180, _2D).
    - **description** (string) - Description of the video.
    - **size** (number) - Size of the video in bytes.
    - **categories** (array) - Optional list of Home Screen categories assigned to the video.
    - **hidden** (boolean) - Indicates if the video is hidden.
  - **hidden** (boolean) - Optional. True if the app is hidden on the Home Screen.
  - **forceInstall** (boolean) - Optional. True if Force Install is enabled for the app.
  - **autoGrantPermissions** (boolean) - Optional. True if Automatically Grant Permissions is enabled.
  - **expirationTimestamp** (number) - Optional. Expiration date of the shared app in milliseconds since 1970.
  - **expirationBehavior** (string) - Optional. Behavior when expirationTimestamp is reached (NONE, DISABLE_APP, DELETE_APP).

### Response Example
```json
{
  "apps": [
    {
      "videos": [
        {
          "id": "2656f354-9723-43f5-9165-f4b2a8662ab0",
          "title": "Example Video",
          "videoType": "_360",
          "description": "5 minute video of Patagonia",
          "size": 1024,
          "categories": [
            "Field Trips",
            "South America"
          ],
          "hidden": false
        }
      ],
      "hidden": true,
      "forceInstall": false,
      "autoGrantPermissions": true,
      "expirationTimestamp": 1710566400,
      "expirationBehavior": "DISABLE_APP"
    }
  ]
}
```
```

--------------------------------

### Upload App with Bundled Files and Specify Device Installation Path

Source: https://docs.managexr.com/cli-reference/command/upload-app

Upload an APK along with additional bundled files, specifying both the local directory containing the files and their destination path on the device. Authentication is handled via an API key file.

```bash
mxr-cli upload-app /path/to/apkFile.apk --bundle-directory /path/to/directory /path/on/device --api-key-file /path/to/api_key.json
```

--------------------------------

### Pause Updates for Devices

Source: https://docs.managexr.com/api-reference/endpoint/set-pause-updates

Use this example to pause configuration updates for a list of specified devices. Ensure the device IDs are correct and set 'pauseUpdates' to true.

```yaml
POST /organizations/{orgId}/devices/set-pause-updates
openapi: 3.1.0
info:
  title: ManageXR API
  description: API documentation for ManageXR
  version: 1.0.0
servers:
  - url: https://managexrapi.com
    description: ManageXR API Server
security:
  - basicAuth: []
paths:
  /organizations/{orgId}/devices/set-pause-updates:
    post:
      summary: Set pause updates for devices
      description: >
        Pause or resume configuration updates for devices.


        Pausing configuration updates stops a device from syncing with its
        latest Configuration. User-initiated changes to Configurations and
        ManageXR-initiated updates to the ManageXR Admin App and Home Screen
        will not propagate to devices with updates paused.
      parameters:
        - name: orgId
          in: path
          required: true
          schema:
            type: string
          description: >-
            The ID of the organization. Locate the orgId under Organization
            Settings > API Keys.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                deviceIds:
                  type: array
                  items:
                    type: string
                  description: Array of device IDs (serial numbers) to update.
                pauseUpdates:
                  type: boolean
                  description: >-
                    Whether to pause (true) or resume (false) configuration
                    updates.
              required:
                - deviceIds
                - pauseUpdates
            examples:
              example-pause:
                summary: Pause updates for devices
                value:
                  deviceIds:
                    - 2G0YC1ZF630NZA
                    - PA7950RGGC06043
                  pauseUpdates: true
              example-resume:
                summary: Resume updates for devices
                value:
                  deviceIds:
                    - 2G0YC1ZF630NZA
                    - PA7950RGGC06043
                  pauseUpdates: false
      responses:
        '201': 
          description: Success
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >
        API key based authentication where <encoded-value> is the Base64
        encoding of `API_KEY_ID`:`API_KEY_SECRET`

        - **Username**: The API Key ID.

        - **Password**: The API Key Secret.

```

--------------------------------

### Get Configuration Details

Source: https://docs.managexr.com/api-reference/endpoint/get-configuration

This endpoint retrieves the full configuration details, including webXR links, files, and Wi-Fi network information.

```APIDOC
## GET /configuration

### Description
Retrieves the current configuration details.

### Endpoint
/configuration

### Response
#### Success Response (200)
- **webxrLinks** (array) - Optional list of WebXR Links deployed on the configuration.
  - **id** (string) - Unique identifier of the WebXR link.
  - **url** (string) - Url of the WebXR link.
  - **title** (string) - Title of the WebXR link.
  - **description** (string) - Description of the WebXR link.
  - **categories** (array) - Optional list of Home Screen categories assigned to the WebXR link.
  - **hidden** (boolean) - Optional, true if the WebXR Link is hidden on the Home Screen.
- **files** (array) - Optional list of files deployed on the configuration.
  - **id** (string) - Unique identifier of the file.
  - **path** (string) - Path to file on the device file system.
  - **size** (number) - Size of the file in bytes.
- **wifiNetworks** (array) - Optional list of wifi networks deployed on the configuration.
  - **id** (string) - Unique identifier of the wifi network.
  - **ssid** (string) - SSID of the wifi network.
  - **nickname** (string) - Nickname of the wifi network.
  - **type** (string) - Type of wifi network (OPEN, WPA, WPA_ENTERPRISE, WPA3, WPA3_ENTERPRISE, UNKNOWN).
- **kioskAppId** (string) - Optional, the unique identifier of the Kiosk App.

#### Response Example
{
  "webxrLinks": [
    {
      "id": "1Gvlpc3JVGcynBrWSJwI",
      "url": "http://www.thechinaguide.com/destination/great-wall-of-china",
      "title": "Great wall of China",
      "description": "A grand tour of the great wall of China, from the comfort of your seat.",
      "categories": [
        "Field Trips",
        "Asia"
      ],
      "hidden": true
    }
  ],
  "files": [
    {
      "id": "0uZN2kuoQhcZJglgVNTc",
      "path": "/foo/bar/myFile.png",
      "size": 1024
    }
  ],
  "wifiNetworks": [
    {
      "id": "1tZw3kuoOfcZMgbIs8",
      "ssid": "SF_Office_123",
      "nickname": "SF Office wifi main",
      "type": "WPA_ENTERPRISE"
    }
  ],
  "kioskAppId": "10707AB329856"
}
```

--------------------------------

### Duplicate App Version with JSON File Auth

Source: https://docs.managexr.com/cli-reference/command/duplicate-app

Use this command to duplicate an existing app version by providing authentication details via a JSON file. This is a basic usage example.

```bash
mxr-cli duplicate-app-version com.myapp.quest 42 "4.2.0" "Stable" --api-key-file /path/to/api_key.json
```

--------------------------------

### Duplicate App Version with Environment Variable Auth

Source: https://docs.managexr.com/cli-reference/command/duplicate-app

This example demonstrates duplicating an app version using API keys stored as environment variables. Ensure MXR_API_KEY_ID and MXR_API_KEY_SECRET are set before execution.

```bash
MXR_API_KEY_ID="xxx" MXR_API_KEY_SECRET="xxx" mxr-cli duplicate-app-version com.myapp.quest 42 "4.2.0" "Stable"
```

--------------------------------

### Add SDK Dependency to manifest.json

Source: https://docs.managexr.com/3d-environment-sdk-reference/setup

Add this line to your project's manifest.json file to install the latest SDK version. Replace VERSION with the desired SDK version.

```json
"com.mxr.mxrus.sdk":"https://www.github.com/ManageXR/mxrus-sdk.git#VERSION"
```

--------------------------------

### Initialize Device Stream in React

Source: https://docs.managexr.com/streaming-sdk-reference/usage

This React component demonstrates how to use the `useDeviceStream` hook to connect to a device and display its video feed. The stream starts when the component renders and stops when it unmounts.

```javascript
import { useDeviceStream } from '@managexr/react-streaming'

const StreamingComponent = ({ deviceId, token }) => {
   const { videoRef } = useDeviceStream(deviceId, token)

   return (
      <div>
         <video ref={videoRef} />
      </div>
   )
}
```

--------------------------------

### Get Device Details

Source: https://docs.managexr.com/api-reference/endpoint/get-device

Fetches comprehensive information about a device, including its configuration, applied tags, operational modes, last sync time, hardware specifications (RAM, storage), location data, and network connectivity.

```APIDOC
## GET /devices/{deviceId}

### Description
Retrieves detailed information about a specific device.

### Method
GET

### Endpoint
/devices/{deviceId}

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the device.

### Response
#### Success Response (200)
- **name** (string) - Configuration name.
- **id** (string) - Configuration id.
- **tags** (array) - The tags applied to the device on ManageXR. Null if device has no tags.
  - **id** (string) - Tag id.
  - **name** (string) - Tag name.
- **tutorialModeEnabled** (boolean) - True if device is in Tutorial Mode.
- **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.
- **lastSync** (string) - The last time the device checked in with ManageXR. Online devices check in every 15 minutes.
- **ram** (object) - Device RAM in bytes.
  - **available** (number) - Available RAM in bytes.
  - **total** (number) - Total RAM in bytes.
- **location** (object) - Device location as determined by its IP address and provided by ipstack.com.
  - **city** (string) - City.
  - **region** (string) - Region.
  - **country** (string) - Country.
  - **continent** (string) - Continent.
  - **timeZone** (string) - Time zone.
  - **latitude** (number) - Latitude.
  - **longitude** (number) - Longitude.
- **connectedWifiNetwork** (object) - Information about the last connected wifi network.
  - **ssid** (string) - The ssid of the last connected wifi network.
- **storage** (object) - The available storage on the device in bytes.
  - **available** (number) - Available storage in bytes.

#### Response Example
{
  "name": "Test Configuration",
  "id": "OZ04csIYkA0EArkeu1vX",
  "tags": [
    {
      "id": "sFidGmedeQofSBcvRcyn",
      "name": "History"
    }
  ],
  "tutorialModeEnabled": false,
  "kioskModeOverride": false,
  "lastSync": "Tue, 18 Jun 2024 21:46:34 GMT",
  "ram": {
    "available": 3704000512,
    "total": 8108634112
  },
  "location": {
    "city": "San Francisco",
    "region": "California",
    "country": "United States",
    "continent": "North America",
    "timeZone": "America/Los_Angeles",
    "latitude": 37,
    "longitude": -122
  },
  "connectedWifiNetwork": {
    "ssid": "TheElectricCity"
  },
  "storage": {
    "available": 107079929856
  }
}
```

--------------------------------

### Enable Tutorial Mode

Source: https://docs.managexr.com/api-reference/endpoint/batch-commands

Enables Tutorial Mode on the listed devices, causing them to launch their designated tutorial app on boot. The tutorial app is configured in Configuration > Device Settings.

```APIDOC
## POST /batch-commands

### Description
Enables Tutorial Mode on the listed devices, causing them to launch their designated tutorial app on boot. The tutorial app is configured in Configuration > Device Settings.

### Method
POST

### Endpoint
/batch-commands

### Request Body
- **deviceIds** (array[string]) - Required - List of unique identifiers (serial numbers) of devices
- **action** (string) - Required - Must be `ENABLE_TUTORIAL_MODE`

### Response
#### Success Response (200)
(No specific fields described for success response body in source)
```

--------------------------------

### OpenAPI Specification for Get Configuration

Source: https://docs.managexr.com/api-reference/endpoint/get-configuration

This OpenAPI 3.1.0 specification defines the GET endpoint for retrieving a configuration by its ID. It includes details on parameters, request structure, and response schemas.

```yaml
openapi: 3.1.0
info:
  title: ManageXR API
  description: API documentation for ManageXR
  version: 1.0.0
servers:
  - url: https://managexrapi.com
    description: ManageXR API Server
security:
  - basicAuth: []
paths:
  /organizations/{orgId}/configurations/{configurationId}:
    get:
      summary: Get configuration
      description: Retrieve a configuration by id
      parameters:
        - name: orgId
          in: path
          required: true
          schema:
            type: string
          description: >-
            The ID of the organization. Locate the orgId under Organization
            Settings > API Keys.
        - name: configurationId
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier of the configuration
      responses:
        '200':
          description: A configuration object
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: 6qwM6FzJE4o708iqTpWc
                    description: Unique identifier of the configuration
                  name:
                    type: string
                    example: Trial
                    description: Name of the configuration
                  registrationCode:
                    type: string
                    example: f7GbHvH
                    description: >-
                      Configuration code (formerly known as Registration Code)
                      for the configuration. [Learn
                      More](https://help.managexr.com/en/articles/5345978-register-a-device-using-a-registration-code)
                  deviceCount:
                    type: number
                    example: 15
                    description: Number of devices using the configuration
                  deviceExperience:
                    type: string
                    enum:
                      - HOME_SCREEN
                      - KIOSK
                      - DEFAULT
                    description: Device experience set on the configuration
                  apps:
                    type: array
                    description: (Optional) List of all apps deployed on the configuration
                    required: false
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 01b8e51a-15d3-2sd3-a0d8-4c13ff633413
                          description: Unique identifier of the app
                        title:
                          type: string
                          example: Example App
                          description: Title of the app
                        packageName:
                          type: string
                          description: Package name of the app
                          example: com.example.app
                        description:
                          type: string
                          example: Quest version of my example app
                          description: Description of the app
                        versionCode:
                          type: number
                          example: 42
                          description: Numeric code of the app version
                        versionName:
                          type: string
                          example: 1.0.0
                          description: Name of the app version
                        versionLabel:
                          type: string
                          example: Release
                          description: Label applied to the app version
                        apkSize:
                          type: number
                          example: 1024
                          description: Size of the APK file for this app version in bytes
                        obbSize:
                          type: number
                          example: 1024
                          description: >-
                            (Optional) Size of the OBB file for this app version
                            in bytes
                          required: false
                        categories:
                          type: array
                          items:
                            type: string
                          example:
                            - Onboarding
                            - Safety
                          description: >-

```

--------------------------------

### Get Device Sync Status

Source: https://docs.managexr.com/llms.txt

Retrieve app sync status details for devices. For a device's overall up-to-date status, use the top-level `outOfDate` boolean on `GET /v1/devices/{id}`. This endpoint provides per-app detail.

```APIDOC
## GET /v1/get-device-sync-status/{deviceId}

### Description
Retrieve app sync status details for devices. For a device's overall up-to-date status, use the top-level `outOfDate` boolean on `GET /v1/devices/{id}`. This endpoint provides per-app detail.

### Method
GET

### Endpoint
/v1/get-device-sync-status/{deviceId}

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The ID of the device for which to retrieve sync status.

### Response
#### Success Response (200)
- **syncStatus** (array) - A list of sync status objects for each app on the device.
  - **appId** (string) - The ID of the app.
  - **versionId** (string) - The ID of the app version.
  - **status** (string) - The sync status (e.g., "synced", "pending", "failed").
  - **lastSyncTime** (string) - The timestamp of the last sync attempt.

#### Response Example
{
  "syncStatus": [
    {
      "appId": "app_123",
      "versionId": "version_abc",
      "status": "synced",
      "lastSyncTime": "2023-10-27T10:00:00Z"
    },
    {
      "appId": "app_456",
      "versionId": "version_def",
      "status": "pending",
      "lastSyncTime": "2023-10-27T09:55:00Z"
    }
  ]
}
```

--------------------------------

### OpenAPI Specification for Get Device

Source: https://docs.managexr.com/api-reference/endpoint/get-device

This OpenAPI 3.1.0 specification defines the GET /organizations/{orgId}/devices/{deviceId} endpoint for retrieving device details. It outlines parameters, request structure, and response schemas, including various device attributes.

```yaml
openapi: 3.1.0
info:
  title: ManageXR API
  description: API documentation for ManageXR
  version: 1.0.0
servers:
  - url: https://managexrapi.com
    description: ManageXR API Server
security:
  - basicAuth: []
paths:
  /organizations/{orgId}/devices/{deviceId}:
    get:
      summary: Get device
      description: Retrieve a device by id (serial number)
      parameters:
        - name: orgId
          in: path
          required: true
          schema:
            type: string
          description: >-
            The ID of the organization. Locate the orgId under Organization
            Settings > API Keys.
        - name: deviceId
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier (serial number) of the device
      responses:
        '200':
          description: A device object
          content:
            application/json:
              schema:
                type: object
                properties:
                  serial:
                    type: string
                    example: 2G0YC1ZF630NZA
                    description: >-
                      The serial number of the device. Also serves as the ID on
                      ManageXR.
                  name:
                    type: string
                    example: Device_0024
                    description: The name given to the device on ManageXR
                  mac:
                    type: string
                    example: CE:AF:07:47:E0:AE
                    description: Device MAC address
                  model:
                    type: string
                    example: Quest 3
                    description: Device model
                  manufacturer:
                    type: string
                    example: Oculus
                    description: Device manufacturer. Note, Meta devices report as Oculus
                  notes:
                    type: string
                    example: With Taylor L
                    description: The notes given to a device on ManageXR
                  batteryLevel:
                    type: number
                    example: 34
                    description: The battery level of the device
                  batteryIsCharging:
                    type: boolean
                    example: true
                    description: True if the device is charging
                  online:
                    type: boolean
                    example: true
                    description: True if the device is online
                  osVersion:
                    type: string
                    example: 12
                    description: The Android operating system version
                  outOfDate:
                    type: boolean
                    example: false
                    description: >-
                      True if device is not compliant with its configuration on
                      ManageXR
                  pauseUpdates:
                    type: boolean
                    example: false
                    description: >-
                      True if configuration updates are paused for device. 
                      Pausing configuration updates stops a device from syncing
                      with its latest Configuration. User-initiated changes to
                      Configurations and ManageXR-initiated updates to the
                      ManageXR Admin App and Home Screen will not propagate to
                      devices with updates paused.
                  registerDate:
                    type: string
                    format: date-time
                    example: Tue, 27 Feb 2024 07:28:03 GMT
                    description: Date the device was registered on ManageXR
                  updating:
                    type: boolean
                    example: false
                    description: >-
                      True if the device is currently downloading content or
                      firmware
                  factoryResetStatus:
                    type: string
                    enum:
                      - QUEUED
                      - COMPLETE
                      - null
                    example: null
                    description: >-
                      This status is set when an admin sends a factory reset
                      command to a device. Null if no factory reset command has
                      been sent.
                  firmwareVersion:
                    type: string
                    example: 65.0.0.546.341
                    description: Device firmware version
                  configuration:

```

--------------------------------

### Get Device

Source: https://docs.managexr.com/llms.txt

Retrieve a device by id (serial number).

```APIDOC
## GET /v1/get-device/{deviceId}

### Description
Retrieve a device by id (serial number).

### Method
GET

### Endpoint
/v1/get-device/{deviceId}

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The ID (serial number) of the device to retrieve.

### Response
#### Success Response (200)
- **device** (object) - Information about the device.
  - **id** (string) - The ID of the device.
  - **name** (string) - The name of the device.
  - **serialNumber** (string) - The serial number of the device.
  - **configurationId** (string) - The ID of the currently applied configuration.
  - **outOfDate** (boolean) - Indicates if the device is out of date with its current configuration.

#### Response Example
{
  "device": {
    "id": "device_abc",
    "name": "Device 1",
    "serialNumber": "SN123456789",
    "configurationId": "config_789",
    "outOfDate": false
  }
}
```

--------------------------------

### Get Configuration by ID

Source: https://docs.managexr.com/api-reference/endpoint/get-configuration

Retrieves a specific configuration using its organization ID and configuration ID.

```APIDOC
## GET /organizations/{orgId}/configurations/{configurationId}

### Description
Retrieve a configuration by id.

### Method
GET

### Endpoint
/organizations/{orgId}/configurations/{configurationId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - The ID of the organization. Locate the orgId under Organization Settings > API Keys.
- **configurationId** (string) - Required - Unique identifier of the configuration

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the configuration
- **name** (string) - Name of the configuration
- **registrationCode** (string) - Configuration code (formerly known as Registration Code) for the configuration.
- **deviceCount** (number) - Number of devices using the configuration
- **deviceExperience** (string) - Device experience set on the configuration
- **apps** (array) - (Optional) List of all apps deployed on the configuration
  - **id** (string) - Unique identifier of the app
  - **title** (string) - Title of the app
  - **packageName** (string) - Package name of the app
  - **description** (string) - Description of the app
  - **versionCode** (number) - Numeric code of the app version
  - **versionName** (string) - Name of the app version
  - **versionLabel** (string) - Label applied to the app version
  - **apkSize** (number) - Size of the APK file for this app version in bytes
  - **obbSize** (number) - (Optional) Size of the OBB file for this app version in bytes
  - **categories** (array) - 

#### Response Example
{
  "id": "6qwM6FzJE4o708iqTpWc",
  "name": "Trial",
  "registrationCode": "f7GbHvH",
  "deviceCount": 15,
  "deviceExperience": "HOME_SCREEN",
  "apps": [
    {
      "id": "01b8e51a-15d3-2sd3-a0d8-4c13ff633413",
      "title": "Example App",
      "packageName": "com.example.app",
      "description": "Quest version of my example app",
      "versionCode": 42,
      "versionName": "1.0.0",
      "versionLabel": "Release",
      "apkSize": 1024,
      "obbSize": 1024,
      "categories": [
        "Onboarding",
        "Safety"
      ]
    }
  ]
}
```

--------------------------------

### List Configurations

Source: https://docs.managexr.com/llms.txt

Retrieve all configurations.

```APIDOC
## GET /v1/configurations

### Description
Retrieve all configurations.

### Method
GET

### Endpoint
/v1/configurations
```

--------------------------------

### Run ManageXR CLI using Binary

Source: https://docs.managexr.com/cli-reference/introduction

Execute the downloaded ManageXR CLI binary. Ensure the path to the binary is correct for your system.

```bash
path/to/mxr-cli <command> [options]
```

--------------------------------

### Get Device by ID

Source: https://docs.managexr.com/api-reference/endpoint/get-device

Retrieve a device by its unique identifier (serial number) within a specific organization.

```APIDOC
## GET /organizations/{orgId}/devices/{deviceId}

### Description
Retrieve a device by id (serial number).

### Method
GET

### Endpoint
/organizations/{orgId}/devices/{deviceId}

### Parameters
#### Path Parameters
- **orgId** (string) - Required - The ID of the organization. Locate the orgId under Organization Settings > API Keys.
- **deviceId** (string) - Required - Unique identifier (serial number) of the device

### Response
#### Success Response (200)
- **serial** (string) - The serial number of the device. Also serves as the ID on ManageXR.
- **name** (string) - The name given to the device on ManageXR
- **mac** (string) - Device MAC address
- **model** (string) - Device model
- **manufacturer** (string) - Device manufacturer. Note, Meta devices report as Oculus
- **notes** (string) - The notes given to a device on ManageXR
- **batteryLevel** (number) - The battery level of the device
- **batteryIsCharging** (boolean) - True if the device is charging
- **online** (boolean) - True if the device is online
- **osVersion** (string) - The Android operating system version
- **outOfDate** (boolean) - True if device is not compliant with its configuration on ManageXR
- **pauseUpdates** (boolean) - True if configuration updates are paused for device. Pausing configuration updates stops a device from syncing with its latest Configuration. User-initiated changes to Configurations and ManageXR-initiated updates to the ManageXR Admin App and Home Screen will not propagate to devices with updates paused.
- **registerDate** (string) - Date the device was registered on ManageXR
- **updating** (boolean) - True if the device is currently downloading content or firmware
- **factoryResetStatus** (string) - This status is set when an admin sends a factory reset command to a device. Null if no factory reset command has been sent. (Enum: QUEUED, COMPLETE, null)
- **firmwareVersion** (string) - Device firmware version

#### Response Example
{
  "serial": "2G0YC1ZF630NZA",
  "name": "Device_0024",
  "mac": "CE:AF:07:47:E0:AE",
  "model": "Quest 3",
  "manufacturer": "Oculus",
  "notes": "With Taylor L",
  "batteryLevel": 34,
  "batteryIsCharging": true,
  "online": true,
  "osVersion": "12",
  "outOfDate": false,
  "pauseUpdates": false,
  "registerDate": "Tue, 27 Feb 2024 07:28:03 GMT",
  "updating": false,
  "factoryResetStatus": null,
  "firmwareVersion": "65.0.0.546.341"
}
```

--------------------------------

### Create Configuration

Source: https://docs.managexr.com/llms.txt

Create a new configuration. Creates a blank configuration with default settings and no content.

```APIDOC
## POST /v1/create-configuration

### Description
Create a new configuration. Creates a blank configuration with default settings and no content.

### Method
POST

### Endpoint
/v1/create-configuration

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new configuration.

### Request Example
{
  "name": "Default Configuration"
}

### Response
#### Success Response (200)
- **configuration** (object) - The newly created configuration.
  - **id** (string) - The ID of the configuration.
  - **name** (string) - The name of the configuration.
  - **content** (object) - The content of the configuration (initially empty).

#### Response Example
{
  "configuration": {
    "id": "config_789",
    "name": "Default Configuration",
    "content": {}
  }
}
```

--------------------------------

### GET /organizations

Source: https://docs.managexr.com/api-reference/endpoint/list-organizations

Retrieves a list of all organizations that can be controlled with a given API Key. This is useful for managing multiple organizational accounts.

```APIDOC
## GET /organizations

### Description
Retrieve a list of all organizations that can be controlled with a given API Key. This endpoint provides a summary of each organization, including its ID, name, active device count, and total device licenses.

### Method
GET

### Endpoint
/organizations

### Parameters

### Request Body

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the organization
- **name** (string) - Name of the organization
- **activeDevices** (string) - Number of devices currently registered on the organization
- **deviceLicenses** (number) - Number of device licenses

#### Response Example
{
  "example": [
    {
      "id": "A1ZICsr6XwX5fv4E16QM",
      "name": "High school Musical",
      "activeDevices": "30",
      "deviceLicenses": 50
    },
    {
      "id": "EwmhggZ9zYIqMVVMz2s7",
      "name": "Sky High",
      "activeDevices": "50",
      "deviceLicenses": 100
    }
  ]
}
```

--------------------------------

### Upload a file and set its name and description

Source: https://docs.managexr.com/cli-reference/command/upload-file

Upload a file and specify its name and description within ManageXR. This uses JSON file authentication.

```bash
mxr-cli upload-file /path/to/file.ext --name "Fun File" --description "This is the best file ever" --api-key-file /path/to/api_key.json
```

--------------------------------

### Upload App with Environment Variable Authentication

Source: https://docs.managexr.com/cli-reference/command/upload-app

Upload an APK to ManageXR by providing API key credentials directly through environment variables.

```bash
MXR_API_KEY_ID="xxx" MXR_API_KEY_SECRET="xxx" mxr-cli upload-app /path/to/apkfile.apk
```

--------------------------------

### Launch App

Source: https://docs.managexr.com/api-reference/endpoint/batch-commands

Launches a specified application on the listed devices. This command can also include parameters for launching the app.

```APIDOC
## POST /batch-commands

### Description
Launches a specified application on the listed devices. This command can also include parameters for launching the app.

### Method
POST

### Endpoint
/batch-commands

### Request Body
- **deviceIds** (array[string]) - Required - List of unique identifiers (serial numbers) of devices
- **action** (string) - Required - Must be `LAUNCH_APP`
- **data** (object) - Required - Contains details for the launch action
  - **packageName** (string) - Required - The package name of the app to launch
  - **launchParams** (object) - Optional - Parameters to pass when launching the app
    - **userId** (string) - Optional
    - **booleanValue** (boolean) - Optional
    - **floatValue** (number) - Optional
    - **arrayValue** (array[number]) - Optional
    - **mapValue** (object) - Optional
      - **key** (string) - Optional

### Request Example
```json
{
  "deviceIds": [
    "fJlJrjEL08UkhSLRRryd",
    "GrCQfwI4373WFqzVjguI"
  ],
  "action": "LAUNCH_APP",
  "data": {
    "packageName": "com.example.app",
    "launchParams": {
      "userId": "AX3EIUf89",
      "booleanValue": true,
      "floatValue": 100.29,
      "arrayValue": [
        1.23,
        4.56
      ],
      "mapValue": {
        "key": "value"
      }
    }
  }
}
```

### Response
#### Success Response (200)
(No specific fields described for success response body in source)
```

--------------------------------

### Create App

Source: https://docs.managexr.com/llms.txt

Create a managed app (Self-Hosted Only). Add an application to your ManageXR library that you are hosting on your own servers.

```APIDOC
## POST /v1/create-externally-hosted-app

### Description
Create a managed app (Self-Hosted Only). Add an application to your ManageXR library that you are hosting on your own servers.

### Method
POST

### Endpoint
/v1/create-externally-hosted-app

### Parameters
#### Request Body
- **title** (string) - Required - The title of the application.
- **description** (string) - Optional - A description of the application.
- **iconUrl** (string) - Optional - The URL of the application's icon.
- **categories** (array) - Optional - A list of categories the app belongs to.
  - **category** (string) - The name of the category.

### Request Example
{
  "title": "My Self-Hosted App",
  "description": "An example of a self-hosted application.",
  "iconUrl": "https://example.com/icons/my-app.png",
  "categories": ["productivity", "utility"]
}

### Response
#### Success Response (200)
- **app** (object) - The newly created app.
  - **id** (string) - The ID of the app.
  - **title** (string) - The title of the app.
  - **description** (string) - The description of the app.
  - **iconUrl** (string) - The URL of the app's icon.
  - **categories** (array) - The categories of the app.

#### Response Example
{
  "app": {
    "id": "app_456",
    "title": "My Self-Hosted App",
    "description": "An example of a self-hosted application.",
    "iconUrl": "https://example.com/icons/my-app.png",
    "categories": ["productivity", "utility"]
  }
}
```

--------------------------------

### Launch WebXR

Source: https://docs.managexr.com/api-reference/endpoint/batch-commands

Launches a specified WebXR URL on the listed devices.

```APIDOC
## POST /batch-commands

### Description
Launches a specified WebXR URL on the listed devices.

### Method
POST

### Endpoint
/batch-commands

### Request Body
- **deviceIds** (array[string]) - Required - List of unique identifiers (serial numbers) of devices
- **action** (string) - Required - Must be `LAUNCH_WEB_URL`
- **data** (object) - Required - Contains details for the launch action
  - **url** (string) - Required - The URL to launch

### Request Example
```json
{
  "deviceIds": [
    "fJlJrjEL08UkhSLRRryd",
    "GrCQfwI4373WFqzVjguI"
  ],
  "action": "LAUNCH_WEB_URL",
  "data": {
    "url": "https://google.com"
  }
}
```

### Response
#### Success Response (200)
(No specific fields described for success response body in source)
```

--------------------------------

### List Device Sync Status

Source: https://docs.managexr.com/llms.txt

Retrieve sync status details for devices. Currently supports fetching app sync statuses (installed vs. target version) only.

```APIDOC
## GET /v1/device-sync-status

### Description
Retrieve sync status details for devices. Currently supports fetching app sync statuses (installed vs. target version) only.

### Method
GET

### Endpoint
/v1/device-sync-status
```

--------------------------------

### Run ManageXR CLI using NPX

Source: https://docs.managexr.com/cli-reference/introduction

Execute ManageXR CLI commands directly without a global installation using NPX. This is useful for running commands ad-hoc.

```bash
npx @managexr/mxr-cli <command> [options]
```
Tokens:
Raw