Edit Configuration

Edit a configuration

curl --request PATCH \
  --url https://managexrapi.com/v1/configurations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Client Configuration v2",
  "vrContent": [
    {
      "type": "app",
      "id": {
        "packageName": "com.my.customApp",
        "releaseChannel": "prod"
      }
    },
    {
      "type": "video",
      "id": "KSJ34KHDA12MR"
    },
    {
      "type": "app",
      "id": {
        "packageName": "com.my.test1",
        "version": "latest"
      }
    },
    {
      "type": "app",
      "id": {
        "packageName": "com.my.test1",
        "version": {
          "versionCode": 1,
          "versionName": "1.0"
        }
      }
    }
  ],
  "wifiNetworkIds": [
    "1390KJDL139PJD",
    "KAFJ39UT124P98"
  ]
}
'

{
  "data": {
    "id": "sFidGmedeQofSBcvRcyn",
    "name": "Education",
    "registrationCode": "f7GbHvH",
    "deviceCount": 15,
    "deviceExperienceMode": "HOME_SCREEN",
    "vrContent": [
      {
        "id": "av_123",
        "type": "managed",
        "configurationDeployments": {
          "config_123": 1,
          "config_456": 0
        },
        "createdAt": 1645615777448,
        "updatedAt": 1687352117203,
        "versionCode": 83894522,
        "versionName": "8.7.8.1206",
        "versionLabel": "Quest",
        "hidden": false,
        "forceInstall": false,
        "apkSize": 72633861,
        "obbSize": 1024,
        "selfHosted": true,
        "apkUrl": "https://storage.example.com/apps/com.example.app.apk",
        "obbUrl": "https://storage.example.com/apps/com.example.app.obb",
        "sharingOrganizationName": "XR Developer",
        "releaseChannelName": "Production",
        "supportedDeviceModels": [
          "Quest 3",
          "Quest 3S",
          "Pico 4 Ultra Enterprise"
        ]
      }
    ],
    "kioskVrContent": {
      "type": "app",
      "id": {
        "packageName": "<string>",
        "releaseChannel": "<string>",
        "type": "shared"
      }
    },
    "kioskVideoSettings": {
      "loopVideo": true,
      "loopVideoAfterNSecondsHeadsetOff": 30
    },
    "files": [
      {
        "id": "DLO133U5NFLMAL1",
        "url": "https://storage.googleapis.com/managexr-files/org_456/files/file_123abc.mp4",
        "name": "main_assets_all.bundle",
        "size": 1204975930,
        "md5": "7ah69cMtXyaz5OfsCRtOjQ==",
        "description": "Content bundle for training app",
        "libraryDirectoryPath": "/",
        "deviceDirectoryPaths": [
          "/Android/obb/com.managexr.exampleApp/files"
        ]
      }
    ],
    "wifiNetworks": [
      {
        "id": "wifi_abc123",
        "ssid": "MyNetwork",
        "nickname": "Office Wi-Fi",
        "type": "WPA_ENTERPRISE"
      }
    ]
  }
}

PATCH

configurations

{id}

Edit a configuration

curl --request PATCH \
  --url https://managexrapi.com/v1/configurations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Client Configuration v2",
  "vrContent": [
    {
      "type": "app",
      "id": {
        "packageName": "com.my.customApp",
        "releaseChannel": "prod"
      }
    },
    {
      "type": "video",
      "id": "KSJ34KHDA12MR"
    },
    {
      "type": "app",
      "id": {
        "packageName": "com.my.test1",
        "version": "latest"
      }
    },
    {
      "type": "app",
      "id": {
        "packageName": "com.my.test1",
        "version": {
          "versionCode": 1,
          "versionName": "1.0"
        }
      }
    }
  ],
  "wifiNetworkIds": [
    "1390KJDL139PJD",
    "KAFJ39UT124P98"
  ]
}
'

{
  "data": {
    "id": "sFidGmedeQofSBcvRcyn",
    "name": "Education",
    "registrationCode": "f7GbHvH",
    "deviceCount": 15,
    "deviceExperienceMode": "HOME_SCREEN",
    "vrContent": [
      {
        "id": "av_123",
        "type": "managed",
        "configurationDeployments": {
          "config_123": 1,
          "config_456": 0
        },
        "createdAt": 1645615777448,
        "updatedAt": 1687352117203,
        "versionCode": 83894522,
        "versionName": "8.7.8.1206",
        "versionLabel": "Quest",
        "hidden": false,
        "forceInstall": false,
        "apkSize": 72633861,
        "obbSize": 1024,
        "selfHosted": true,
        "apkUrl": "https://storage.example.com/apps/com.example.app.apk",
        "obbUrl": "https://storage.example.com/apps/com.example.app.obb",
        "sharingOrganizationName": "XR Developer",
        "releaseChannelName": "Production",
        "supportedDeviceModels": [
          "Quest 3",
          "Quest 3S",
          "Pico 4 Ultra Enterprise"
        ]
      }
    ],
    "kioskVrContent": {
      "type": "app",
      "id": {
        "packageName": "<string>",
        "releaseChannel": "<string>",
        "type": "shared"
      }
    },
    "kioskVideoSettings": {
      "loopVideo": true,
      "loopVideoAfterNSecondsHeadsetOff": 30
    },
    "files": [
      {
        "id": "DLO133U5NFLMAL1",
        "url": "https://storage.googleapis.com/managexr-files/org_456/files/file_123abc.mp4",
        "name": "main_assets_all.bundle",
        "size": 1204975930,
        "md5": "7ah69cMtXyaz5OfsCRtOjQ==",
        "description": "Content bundle for training app",
        "libraryDirectoryPath": "/",
        "deviceDirectoryPaths": [
          "/Android/obb/com.managexr.exampleApp/files"
        ]
      }
    ],
    "wifiNetworks": [
      {
        "id": "wifi_abc123",
        "ssid": "MyNetwork",
        "nickname": "Office Wi-Fi",
        "type": "WPA_ENTERPRISE"
      }
    ]
  }
}

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 of the configuration

Query Parameters

organizationId

string

Unique identifier of the organization.
Defaults to the organization associated with the API key.

Body

application/json

name

string

Updated name for the configuration

Example:

"Client Configuration v2"

vrContent

(App (Release Channel) · object | App (Specific Version) · object | Video · object | WebXR Link · object)[]

Updated set of VR content on the configuration. Content will appear on the Home Screen in the order it appears in the vrContent array.

We recommend using release channels to deploy apps to configurations to simplify app version management. Instead of updating the app version on every configuration whenever you have an update, simply update the release channel. Learn More

App (Release Channel)
App (Specific Version)
Video
WebXR Link

Show child attributes

vrContent.id

object

Unique identifier of the app

Show child attributes

vrContent.id.packageName

string

required

Package Name of the application

vrContent.id.releaseChannel

string

required

Name of the release channel

vrContent.id.type

enum<string>

Available options:

shared,

managed

vrContent.type

enum<string>

Available options:

app

Example:

"app"

vrContent.properties

object

Optional per item properties.

Show child attributes

vrContent.properties.hidden

boolean

When true, the content item is hidden on the Home Screen. Omit this field (or set to false) to show the item.

vrContent.properties.forceInstall

boolean

When true uninstalls previous version of app before re-installing new version. Turn on Force Install if you need to downgrade or rollback an app version. Learn More

kioskVrContent

App (Release Channel) · object

Set the App or video to kiosk devices into.

Requirements:

The deviceExperience field must also be set to KIOSK or KIOSK_VIDEO
The App or Video must be included in the configurations vrContent already (or in this request)

App (Release Channel)
App (Specific Version)
Video

Show child attributes

kioskVrContent.type

enum<string>

Available options:

app

Example:

"app"

kioskVrContent.id

object

Unique identifier of the app

Show child attributes

kioskVrContent.id.packageName

string

required

Package Name of the application

kioskVrContent.id.releaseChannel

string

required

Name of the release channel

kioskVrContent.id.type

enum<string>

Available options:

shared,

managed

deviceExperienceMode

enum<string>

Device experience

KIOSK is Kiosk App. Options vary by device type. See supported device information here.

Available options:

HOME_SCREEN,

KIOSK,

KIOSK_VIDEO,

DEFAULT

Example:

"HOME_SCREEN"

confirmMetaDeviceModeChange

boolean

Only required if deviceExperience change impacts Meta Horizon managed services device mode. Supplying the flag confirms that you understand the risks and requirements of the mode change._

Example:

false

wifiNetworkIds

string[]

Unique identifiers of wi-fi networks to deploy on the configuration

files

object

Show child attributes

files.id

string

Unique identifier of the file

Example:

"DLO133U5NFLMAL1"

files.deviceDirectoryPaths

string[]

Array of directory paths to deploy the file on the device. Each entry in the array should include the full path as a string. This field is an array because, although uncommon, you can deploy the same file to multiple different locations on a device.

Example:

{
  "id": "DLO133U5NFLMAL1",
  "deviceDirectoryPaths": [
    "/Android/obb/com.managexr.exampleApp/files"
  ]
}

Response

The updated configuration

data

object

Full representation of a configuration.

Show child attributes

data.id

string

Unique identifier of the configuration.

Example:

"sFidGmedeQofSBcvRcyn"

data.name

string

Name of the configuration.

Example:

"Education"

data.registrationCode

string

Configuration code (formerly known as registration code) used for enrollment.

Example:

"f7GbHvH"

data.deviceCount

number

Number of devices using the configuration.

Example:

15

data.deviceExperienceMode

enum<string>

Device experience set on the configuration. Default is Home Screen.

Available options:

HOME_SCREEN,

KIOSK,

KIOSK_VIDEO,

DEFAULT

Example:

"HOME_SCREEN"

data.vrContent

(Apps · object | Video · object | WebXR Link · object)[]

An array of VR content deployed on the configuration. Fields vary by content type. Objects are ordered in the manner they appear on the Home Screen.

Apps deployed on the configuration will include the attributes listed below

Apps
Video
WebXR Link

Show child attributes

data.vrContent.id

string

Unique identifier of the app version

Example:

"av_123"

data.vrContent.type

enum<string>

Type of the app version

Available options:

managed,

shared,

external,

instant

Example:

"managed"

data.vrContent.configurationDeployments

object

Map of configuration ids to device count using application

Show child attributes

data.vrContent.configurationDeployments.{key}

number

Example:

{ "config_123": 1, "config_456": 0 }

data.vrContent.createdAt

number

Creation timestamp

Example:

1645615777448

data.vrContent.updatedAt

number

Last update timestamp

Example:

1687352117203

data.vrContent.versionCode

number

Version code of the app

Example:

83894522

data.vrContent.versionName

string

Version name of the app

Example:

"8.7.8.1206"

data.vrContent.versionLabel

string

Label for uniqueness among app versions

Example:

"Quest"

data.vrContent.hidden

boolean

Whether the app is hidden from the VR home screen

Example:

false

data.vrContent.forceInstall

boolean

When true uninstalls previous version of app before re-installing new version. Turn on Force Install if you need to downgrade or rollback an app version. Learn More

Example:

false

data.vrContent.apkSize

number

Size of the APK file in bytes

Example:

72633861

data.vrContent.obbSize

number

Size of the OBB file in bytes

Example:

1024

data.vrContent.selfHosted

boolean

Whether the app is self-hosted

Example:

true

data.vrContent.apkUrl

string

URL of the APK file (self-hosted apps only)

Example:

"https://storage.example.com/apps/com.example.app.apk"

data.vrContent.obbUrl

string

URL of the OBB file (self-hosted apps only)

Example:

"https://storage.example.com/apps/com.example.app.obb"

Name of the organization sharing the app (shared apps only)

Example:

"XR Developer"

data.vrContent.releaseChannelName

string

Name of the release channel (shared apps only)

Example:

"Production"

data.vrContent.supportedDeviceModels

string[]

List of supported device models for Instant App (instant apps only)

Example:

[
  "Quest 3",
  "Quest 3S",
  "Pico 4 Ultra Enterprise"
]

data.kioskVrContent

App (Release Channel) · object

App (Release Channel)
App (Specific Version)
Video

Show child attributes

data.kioskVrContent.type

enum<string>

Available options:

app

Example:

"app"

data.kioskVrContent.id

object

Unique identifier of the app

Show child attributes

data.kioskVrContent.id.packageName

string

required

Package Name of the application

data.kioskVrContent.id.releaseChannel

string

required

Name of the release channel

data.kioskVrContent.id.type

enum<string>

Available options:

shared,

managed

data.kioskVideoSettings

object

Only relevant if configuration deviceExperienceMode is KIOSK_VIDEO

Show child attributes

data.kioskVideoSettings.loopVideo

boolean

Whether to play the video on loop

Example:

true

data.kioskVideoSettings.loopVideoAfterNSecondsHeadsetOff

enum<number>

Reset video play position to the beginning after headset has been taken off for N seconds

Available options:

0,

3,

10,

20,

30,

60,

300,

600

Example:

30

data.files

object[]

Files deployed on the configuration.

Show child attributes

data.files.id

string

Unique identifier of the file

Example:

"DLO133U5NFLMAL1"

data.files.url

string<uri>

Direct URL to download the file. If hosted on ManageXR, the link will begin with gs://. If self-hosted, it will be the url you supplied when creating the file.

Example:

"gs://mighty-platform-prod/organizations/GMrDmBCRcUm4bf61nqH2/files/e75058f2-ee65-4a79-802e-b97af54b6b26"

data.files.name

string

Name of the file, including extension

Example:

"main_assets_all.bundle"

data.files.size

number

Size of the file in bytes

Example:

1204975930

data.files.md5

string

MD5 hash of the file for integrity verification

Example:

"7ah69cMtXyaz5OfsCRtOjQ=="

data.files.description

string

Optional description of the file's contents or purpose

Example:

"Content bundle for training app"

data.files.libraryDirectoryPath

string

Path to the file in the Library > Files section of ManageXR. A libraryDirectoryPath of "/" indicates that it is at the root of the Files library.

Example:

"/"

data.files.deviceDirectoryPaths

string[]

Directory paths where the file is placed on the device. This is an array because, although uncommon, you can deploy a file to more than one location on a device.

Example:

[
  "/Android/obb/com.managexr.exampleApp/files"
]

data.wifiNetworks

object[]

Wi‑Fi network profiles deployed on the configuration.

Show child attributes

data.wifiNetworks.id

string

Unique identifier of the Wi-Fi network

Example:

"wifi_abc123"

data.wifiNetworks.ssid

string

The SSID (name) of the Wi-Fi network

Example:

"MyNetwork"

data.wifiNetworks.nickname

string

A user-defined label for the network

Example:

"Office Wi-Fi"

data.wifiNetworks.type

enum<string>

The security type of the network

Available options:

OPEN,

WPA,

WPA_ENTERPRISE,

WPA3,

WPA3_ENTERPRISE,

UNKNOWN

Example:

"WPA_ENTERPRISE"

Duplicate Configuration Delete Configuration

⌘I

Getting Started

Devices

Configurations

Apps

App Versions & Release Channels

Library

Tags

Organizations

Authorizations

Path Parameters

Query Parameters

Body

Response