{ "openapi": "3.0.0", "info": { "title": "ArborXR MDM API", "description": "This API provides a RESTful interface to interact with your organization's devices under management.", "termsOfService": "https:\/\/arborxr.com\/terms-of-service\/", "contact": { "name": "ArborXR", "url": "https:\/\/arborxr.com", "email": "support@arborxr.com" }, "version": "v3" }, "servers": [ { "url": "https:\/\/api.xrdm.app\/api\/v3" } ], "paths": { "\/token-info": { "get": { "tags": [ "API Info" ], "description": "Get information about the currently authenticated API token, including its name, API version, and associated organization.", "operationId": "GetTokenInfo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "token_name", "display_token", "api_version", "organization_id", "base_path" ], "type": "object", "properties": { "token_name": { "type": "string", "example": "My API Token" }, "display_token": { "type": "string", "example": "trt1R8vF..." }, "api_version": { "enum": [ "v2", "v3" ], "type": "string", "example": "v2" }, "organization_id": { "type": "string", "format": "uuid", "example": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d" }, "base_path": { "enum": [ "\/api\/v2", "\/api\/v3" ], "type": "string", "example": "\/api\/v2" } } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "servers": [ { "url": "https:\/\/api.xrdm.app\/api" } ] }, "\/": { "get": { "tags": [ "API Info" ], "description": "Get info about the API.", "operationId": "GetApiInfo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "name", "description", "version", "documentation", "authentication", "rateLimiting", "contact", "termsOfService" ], "type": "object", "properties": { "name": { "type": "string", "example": "ArborXR API" }, "description": { "type": "string", "example": "The REST API for ArborXR." }, "version": { "type": "string", "example": "v3" }, "documentation": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/docs" }, "authentication": { "type": "string", "example": "Bearer token; required. Generate a token in the ArborXR Portal by navigating to: Settings > Access Tokens." }, "rateLimiting": { "type": "string", "example": "2000 requests per minute per organization." }, "contact": { "type": "string", "example": "support@arborxr.com" }, "termsOfService": { "type": "string", "example": "https:\/\/arborxr.com\/terms-of-service\/" } } } } } } } } }, "\/current-organization": { "get": { "tags": [ "Organizations" ], "description": "Get the current organization.", "operationId": "GetCurrentOrganization", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/current-user": { "get": { "tags": [ "Users" ], "description": "Get the current user.", "operationId": "GetCurrentUser", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "accessControls": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "userId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "role": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Administrator" }, "description": { "type": "string", "example": "Full access to all system features and settings." }, "type": { "enum": [ "organization", "group" ], "type": "string", "example": "organization" }, "isOwnedBySystem": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "protectable": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "enum": [ "organization", "group", "device" ], "type": "string", "example": "organization" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/users": { "get": { "tags": [ "Users" ], "description": "Get a paginated list of users in your organization. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetUsers", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "accessControls": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "userId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "role": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Administrator" }, "description": { "type": "string", "example": "Full access to all system features and settings." }, "type": { "enum": [ "organization", "group" ], "type": "string", "example": "organization" }, "isOwnedBySystem": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "protectable": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "enum": [ "organization", "group", "device" ], "type": "string", "example": "organization" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } }, "example": [ { "url": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=1", "label": "pagination.previous", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=1", "label": "1", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=2", "label": "2", "active": true }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=3", "label": "3", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/users?per_page=10page=3", "label": "pagination.next", "active": false } ] } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/users" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of users." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Users" ], "description": "Create a new user in your organization. **Best Practice:** For most use cases, we recommend using [`CreateUserInvite`](#operation\/CreateUserInvite). This automatically emails the user a link to set their password and log in. Use [`CreateUser`](#operation\/CreateUser) only if authentication is handled via *SSO*. If used for standard accounts, users will not receive an email and must manually navigate to [https:\/\/app.arborxr.com](https:\/\/app.arborxr.com) to trigger a *Forgot Password* flow to access their account.", "operationId": "CreateUser", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "Create a new user", "content": { "application\/json": { "schema": { "required": [ "firstName", "lastName", "email", "defaultRoleId" ], "type": "object", "properties": { "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "defaultRoleId": { "type": "string", "description": "The default role assigned to the user. Can be an organization role or a group role.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "groupRoles": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "required": [ "roleId", "groupId" ], "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "groupId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174002" } } }, "description": "Optional group roles to assign to the user upon creation." } } } } } }, "responses": { "201": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "accessControls": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "userId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "role": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Administrator" }, "description": { "type": "string", "example": "Full access to all system features and settings." }, "type": { "enum": [ "organization", "group" ], "type": "string", "example": "organization" }, "isOwnedBySystem": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "protectable": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "enum": [ "organization", "group", "device" ], "type": "string", "example": "organization" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/users\/{userId}": { "get": { "tags": [ "Users" ], "description": "Get a single user.", "operationId": "GetUser", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "userId", "in": "path", "description": "The ID of a user.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "accessControls": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "userId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "role": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Administrator" }, "description": { "type": "string", "example": "Full access to all system features and settings." }, "type": { "enum": [ "organization", "group" ], "type": "string", "example": "organization" }, "isOwnedBySystem": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "protectable": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "enum": [ "organization", "group", "device" ], "type": "string", "example": "organization" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Users" ], "description": "Update a user.", "operationId": "UpdateUser", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "userId", "in": "path", "description": "The ID of a user.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Update a user", "content": { "application\/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "defaultRoleId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "groupRoles": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "required": [ "roleId", "groupId", "action" ], "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "groupId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174002" }, "action": { "enum": [ "attach", "detach" ], "type": "string", "description": "Specify whether to attach or detach the group role from the user.", "example": "attach" } } }, "description": "Group roles to attach or detach from the user." } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "accessControls": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "userId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "role": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Administrator" }, "description": { "type": "string", "example": "Full access to all system features and settings." }, "type": { "enum": [ "organization", "group" ], "type": "string", "example": "organization" }, "isOwnedBySystem": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "protectable": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "type": { "enum": [ "organization", "group", "device" ], "type": "string", "example": "organization" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Users" ], "description": "Delete a user.", "operationId": "DeleteUser", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "userId", "in": "path", "description": "The ID of a user.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/user-invites": { "post": { "tags": [ "User Invites" ], "description": "Invite a user to your organization.", "operationId": "CreateUserInvite", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "The fields required to invite a user.", "content": { "application\/json": { "schema": { "required": [ "email", "defaultRoleId" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the user to invite.", "format": "email", "example": "w.white@example.com" }, "isSsoEnforced": { "type": "boolean", "description": "Should the user be required to authenticate using the organization's configured IdP?", "example": true }, "defaultRoleId": { "type": "string", "description": "The default role assigned to the user. Can be an organization role or a group role.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "groupRoles": { "maxItems": 100, "minItems": 0, "type": "array", "items": { "required": [ "roleId", "groupId" ], "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "groupId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174002" } } }, "description": "Optional group roles to assign to the user upon invitation." } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/roles": { "get": { "tags": [ "Roles" ], "description": "Get a list of roles. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetRoles", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Administrator" }, "description": { "type": "string", "example": "Full access to all system features and settings." }, "type": { "enum": [ "organization", "group" ], "type": "string", "example": "organization" }, "isOwnedBySystem": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } }, "example": [ { "url": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=1", "label": "pagination.previous", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=1", "label": "1", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=2", "label": "2", "active": true }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=3", "label": "3", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/roles?per_page=10page=3", "label": "pagination.next", "active": false } ] } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/roles" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of roles." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/roles\/{roleId}": { "get": { "tags": [ "Roles" ], "description": "Get a single role.", "operationId": "GetRole", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "roleId", "in": "path", "description": "The ID of a role.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Administrator" }, "description": { "type": "string", "example": "Full access to all system features and settings." }, "type": { "enum": [ "organization", "group" ], "type": "string", "example": "organization" }, "isOwnedBySystem": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/app-bundles": { "post": { "tags": [ "App Bundles" ], "description": "Create a new app bundle from existing build and files.", "operationId": "CreateAppBundle", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "Create a new app bundle from existing build and files. Labels are auto-generated.", "content": { "application\/json": { "schema": { "required": [ "appBuildId" ], "type": "object", "properties": { "appBuildId": { "type": "string", "description": "UUID of the existing app build to associate with this bundle", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" }, "files": { "type": "array", "items": { "required": [ "fileId" ], "type": "object", "properties": { "fileId": { "type": "string", "description": "UUID of the existing file", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "path": { "type": "string", "description": "Optional custom device path for the file", "example": "\/sdcard\/custom" } } }, "description": "Optional array of files to associate with the bundle" }, "releaseChannelId": { "type": "string", "description": "UUID of an existing release channel to associate with this bundle. Cannot be specified together with newReleaseChannelTitle.", "format": "uuid", "example": "660e8400-e29b-41d4-a716-446655440001" }, "newReleaseChannelTitle": { "type": "string", "description": "Title for a new release channel to create and associate with this bundle. Cannot be specified together with releaseChannelId.", "example": "Beta Channel" } } } } } }, "responses": { "201": { "description": "App bundle created successfully.", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/app-bundles\/{appBundleId}": { "get": { "tags": [ "App Bundles" ], "description": "Get a specific app bundle by ID.", "operationId": "GetAppBundle", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appBundleId", "in": "path", "description": "The ID of an app bundle.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "App bundle details response", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "patch": { "tags": [ "App Bundles" ], "description": "Update an app bundle's label. The label can be set to null to remove it.", "operationId": "UpdateAppBundle", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appBundleId", "in": "path", "description": "The ID of an app bundle.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Update an app bundle's label. Set to null to remove the label.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "label": { "maxLength": 60, "type": "string", "description": "The label for the app bundle. Set to null to remove.", "nullable": true, "example": "Production Release" } } } } } }, "responses": { "200": { "description": "App bundle details response", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/app-bundles\/{appBundleId}\/files": { "get": { "tags": [ "App Bundles" ], "description": "Get all files for a specific app bundle.", "operationId": "GetAppBundleFiles", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appBundleId", "in": "path", "description": "The ID of an app bundle.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "App bundle files list response", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "name", "location", "bundlePaths", "sizeBytes", "checksum", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "config.json" }, "location": { "type": "string", "example": "\/sdcard\/myapp" }, "bundlePaths": { "type": "array", "items": { "type": "string" }, "example": [ "\/sdcard\/myapp\/config.json" ] }, "sizeBytes": { "type": "integer", "example": 2621440 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } }, "example": [ { "url": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=1", "label": "pagination.previous", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=1", "label": "1", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=2", "label": "2", "active": true }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=3", "label": "3", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files?per_page=10page=3", "label": "pagination.next", "active": false } ] } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-bundles\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25\/files" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "App Bundles" ], "description": "Add files to an existing app bundle.", "operationId": "AddFilesToAppBundle", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appBundleId", "in": "path", "description": "The ID of an app bundle.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Files to add to the app bundle", "content": { "application\/json": { "schema": { "required": [ "files" ], "type": "object", "properties": { "files": { "type": "array", "items": { "required": [ "fileId" ], "type": "object", "properties": { "fileId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "path": { "type": "string", "description": "Optional custom device path for the file", "example": "\/sdcard\/custom\/path" } } } } } } } } }, "responses": { "201": { "description": "App bundle details response", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/app-bundles\/{appBundleId}\/finalize": { "post": { "tags": [ "App Bundles" ], "description": "Finalize an app bundle by setting its status to processing after validating all related builds and files are not pending.", "operationId": "FinalizeAppBundle", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appBundleId", "in": "path", "description": "The ID of an app bundle.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "App bundle details response", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps": { "get": { "tags": [ "Apps" ], "description": "Get a paginated list of apps. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetApps", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of apps." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Apps" ], "description": "Create a new app.", "operationId": "CreateApp", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "The app to create.", "content": { "application\/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "type": "string", "description": "The name of the app.", "example": "My App" }, "deviceModelIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of device model IDs that this app is compatible with. Use the GET \/device-models?full=true endpoint to get the list of available device model IDs.", "example": [ "550e8400-e29b-41d4-a716-446655440000" ] } } } } }, "required": true }, "responses": { "201": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}": { "get": { "tags": [ "Apps" ], "description": "Get a single app.", "operationId": "GetApp", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Apps" ], "description": "Update an app.", "operationId": "UpdateApp", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The app fields to update.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/versions": { "get": { "tags": [ "Apps" ], "description": "Get a paginated list of app versions. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetAppVersions", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "sha256[]", "in": "query", "description": "Filter app versions by SHA256 checksums. This parameter allows you to search for versions matching any of the provided checksums. Maximum 10 checksums per request. The checksums should be provided as a query-parameter array. e.g. `?sha256[]=abc123&sha256[]=def456`.", "required": false, "style": "form", "explode": true, "schema": { "maxItems": 10, "minItems": 1, "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/versions?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/versions?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/versions?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/versions?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/versions?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/versions" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of app versions." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Apps" ], "description": "Initiate a multipart upload for a new version of an app.", "operationId": "InitiateAppVersionUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Initiate a new app version upload.", "content": { "application\/json": { "schema": { "required": [ "filename" ], "type": "object", "properties": { "filename": { "type": "string", "example": "my-app.apk" }, "releaseChannelId": { "type": "string", "description": "Mutually exclusive from newReleaseChannelTitle", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "newReleaseChannelTitle": { "type": "string", "description": "Mutually exclusive from releaseChannelId", "example": "My New Beta Channel" }, "appBuildType": { "enum": [ "standalone", "app-bundle" ], "type": "string", "description": "Type of app build. Use 'app-bundle' to create an AppBundle with PENDING status. Defaults to 'standalone'.", "example": "app-bundle" } } }, "examples": { "Specify Existing Release Channel": { "value": { "filename": "my-app.apk", "releaseChannelId": "123e4567-e89b-12d3-a456-426614174000" } }, "Create New Release Channel": { "value": { "filename": "my-app.apk", "newReleaseChannelTitle": "My New Beta Channel" } }, "Don't Specify Release Channel": { "value": { "filename": "my-app.apk" } }, "Create App Bundle": { "value": { "filename": "my-app.apk", "appBuildType": "app-bundle" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/apps\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-app.apk" }, "versionId": { "type": "string", "format": "uuid", "example": "f40d390d-94fc-47a9-952c-8b7321f3eefc" }, "appBundleId": { "type": "string", "description": "Only returned when appBuildType is 'app-bundle'", "format": "uuid", "example": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6" } }, "example": { "uploadId": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ", "key": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/apps\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-app.apk", "versionId": "f40d390d-94fc-47a9-952c-8b7321f3eefc", "appBundleId": "a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6" } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/versions\/{versionId}\/pre-sign": { "post": { "tags": [ "Apps" ], "description": "Pre-sign URLs for a multipart upload of a new version of an app.", "operationId": "PreSignAppVersionUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "versionId", "in": "path", "description": "The ID of an app version.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The fields to retrieve presigned URLs.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "partNumbers" ], "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/apps\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-app.apk" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "partNumbers": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "integer", "example": 1 }, "example": [ 1, 2, 3 ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "partNumber": { "type": "integer", "example": 1 }, "url": { "type": "string", "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk?partNumber=1&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" } } } }, "example": [ { "partNumber": 1, "presignedUrl": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk?partNumber=1&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, { "partNumber": 2, "presignedUrl": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk?partNumber=2&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, { "partNumber": 3, "presignedUrl": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk?partNumber=3&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" } ] } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/versions\/{versionId}\/complete": { "post": { "tags": [ "Apps" ], "description": "Complete a multipart upload for a new version of an app.", "operationId": "CompleteAppVersionUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "versionId", "in": "path", "description": "The ID of an app version.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The fields to complete the upload.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "parts" ], "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/apps\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-app.apk" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "parts": { "minItems": 1, "type": "array", "items": { "required": [ "partNumber", "eTag" ], "type": "object", "properties": { "partNumber": { "type": "integer", "example": 1 }, "eTag": { "type": "string", "example": "d41d8cd98f00b204e9800998ecf8427e" } } }, "example": [ { "partNumber": 1, "eTag": "d41d8cd98f00b204e9800998ecf8427e" }, { "partNumber": 2, "eTag": "d41d8cd98f00b204e9800998ecf8427e" }, { "partNumber": 3, "eTag": "d41d8cd98f00b204e9800998ecf8427e" } ] }, "versionName": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "releaseNotes": { "type": "string", "nullable": true, "example": "This is a new version." } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/app-bundles": { "get": { "tags": [ "Apps" ], "description": "Get a paginated list of app bundles for an app. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetAppBundles", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "status", "in": "query", "description": "Filter by bundle status", "required": false, "schema": { "enum": [ "pending", "processing", "available", "failed" ], "type": "string" } } ], "responses": { "200": { "description": "App bundles list response", "content": { "application\/json": { "schema": { "required": [ "data", "links", "meta" ], "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer", "nullable": true }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer", "nullable": true }, "total": { "type": "integer" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/files": { "get": { "tags": [ "Apps" ], "description": "Get all bundled files for an app. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetAppFiles", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "sha512[]", "in": "query", "description": "Filter files by SHA512 checksums. This parameter allows you to search for files matching any of the provided checksums. Maximum 10 checksums per request. The checksums should be provided as a query-parameter array. e.g. `?sha512[]=abc123&sha512[]=def456`.", "required": false, "style": "form", "explode": true, "schema": { "maxItems": 10, "minItems": 1, "items": { "type": "string" } } } ], "responses": { "200": { "description": "App files list response", "content": { "application\/json": { "schema": { "required": [ "data", "links", "meta" ], "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "filename": { "type": "string", "example": "my-file.txt" }, "location": { "type": "string", "example": "\/sdcard\/files\/my_directory" }, "sizeBytes": { "type": "integer", "nullable": true, "example": 105906176 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "tag1", "tag2" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/files\/{fileId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "last": { "type": "string" }, "prev": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "from": { "type": "integer", "nullable": true }, "last_page": { "type": "integer" }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "to": { "type": "integer", "nullable": true }, "total": { "type": "integer" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/release-channels": { "get": { "tags": [ "Apps" ], "description": "Get a paginated list of release channels for an app. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetAppReleaseChannels", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Stable" }, "app": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } }, "version": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "bundle": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "targetVersion": { "type": "string", "example": "1.2.3" }, "installedVersion": { "type": "string", "nullable": true, "example": "1.1.1" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/apps\/{appId}\/release-channels\/{releaseChannelId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of release channels." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/release-channels\/{releaseChannelId}": { "get": { "tags": [ "Apps" ], "description": "Get a single release channel for an app.", "operationId": "GetAppReleaseChannel", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "releaseChannelId", "in": "path", "description": "The ID of a release channel.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Stable" }, "app": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } }, "version": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "bundle": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "targetVersion": { "type": "string", "example": "1.2.3" }, "installedVersion": { "type": "string", "nullable": true, "example": "1.1.1" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/apps\/{appId}\/release-channels\/{releaseChannelId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Apps" ], "description": "Update a release channel's target build.", "operationId": "UpdateReleaseChannel", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "releaseChannelId", "in": "path", "description": "The ID of a release channel.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The release channel fields to update.", "content": { "application\/json": { "schema": { "type": "object", "oneOf": [ { "required": [ "versionId" ] }, { "required": [ "bundleId" ] } ], "properties": { "versionId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "bundleId": { "type": "string", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Stable" }, "app": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } }, "version": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "bundle": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "targetVersion": { "type": "string", "example": "1.2.3" }, "installedVersion": { "type": "string", "nullable": true, "example": "1.1.1" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/apps\/{appId}\/release-channels\/{releaseChannelId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/release-channels\/{releaseChannelId}\/share": { "post": { "tags": [ "Apps" ], "description": "Share a release channel with another organization.", "operationId": "ShareReleaseChannel", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "releaseChannelId", "in": "path", "description": "The ID of a release channel.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The details of the organization with which you want to share\/unshare the release channel.", "content": { "application\/json": { "schema": { "required": [ "organizationSlug" ], "type": "object", "properties": { "organizationSlug": { "type": "string", "example": "another-organization-inc" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Release channel shared with organization slug: 'another-organization-inc'." } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/release-channels\/{releaseChannelId}\/unshare": { "post": { "tags": [ "Apps" ], "description": "Unshare a release channel with another organization.", "operationId": "UnshareReleaseChannel", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "releaseChannelId", "in": "path", "description": "The ID of a release channel.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The details of the organization with which you want to share\/unshare the release channel.", "content": { "application\/json": { "schema": { "required": [ "organizationSlug" ], "type": "object", "properties": { "organizationSlug": { "type": "string", "example": "another-organization-inc" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Release channel revoked from organization slug: 'another-organization-inc'." } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/tags\/attach": { "patch": { "tags": [ "Apps" ], "description": "Attach tags to an app.", "operationId": "AttachTagsToApp", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/tags\/detach": { "patch": { "tags": [ "Apps" ], "description": "Detach tags from an app.", "operationId": "DetachTagsFromApp", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/files": { "get": { "tags": [ "Files" ], "description": "Get a paginated list of files. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetFiles", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "filename": { "type": "string", "example": "my-file.txt" }, "location": { "type": "string", "example": "\/sdcard\/files\/my_directory" }, "sizeBytes": { "type": "integer", "nullable": true, "example": 105906176 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "tag1", "tag2" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/files\/{fileId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } }, "example": [ { "url": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=1", "label": "pagination.previous", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=1", "label": "1", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=2", "label": "2", "active": true }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=3", "label": "3", "active": false }, { "url": "https:\/\/api.xrdm.app\/api\/v3\/files?per_page=10page=3", "label": "pagination.next", "active": false } ] } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/files" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of files." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Files" ], "description": "Initiate a multipart upload for a new file.", "operationId": "InitiateFileUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "Initiate a new file upload.", "content": { "application\/json": { "schema": { "required": [ "filename", "path" ], "type": "object", "properties": { "filename": { "type": "string", "description": "Name of the file to upload. Cannot end with .apk or .obb (except .obb files are allowed when appBundleId is provided).", "example": "my-file.txt" }, "path": { "type": "string", "example": "\/sdcard\/my-files\/some-sub-directory" }, "appBundleId": { "type": "string", "description": "Optional UUID of an existing app bundle to associate this file with", "format": "uuid", "example": "550e8400-e29b-41d4-a716-446655440000" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/files\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/123e4567-e89b-12d3-a456-426614174000\/my-file.txt" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "fileId": { "type": "string", "format": "uuid", "example": "9d6a9043-e469-4239-9cc5-147fb20905d9" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/files\/{fileId}": { "get": { "tags": [ "Files" ], "description": "Get a single file.", "operationId": "GetFile", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "filename": { "type": "string", "example": "my-file.txt" }, "location": { "type": "string", "example": "\/sdcard\/files\/my_directory" }, "sizeBytes": { "type": "integer", "nullable": true, "example": 105906176 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "tag1", "tag2" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/files\/{fileId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Files" ], "description": "Delete a file.", "operationId": "DeleteFile", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/files\/{fileId}\/pre-sign": { "post": { "tags": [ "Files" ], "description": "Pre-sign URLs for a multipart upload of a new file.", "operationId": "PreSignFileUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The fields to retrieve presigned URLs.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "partNumbers" ], "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/files\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-file.txt" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "partNumbers": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "integer", "example": 1 }, "example": [ 1, 2, 3 ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "partNumber": { "type": "integer", "example": 1 }, "presignedUrl": { "type": "string", "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.txt?partNumber=1&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" } } } }, "example": [ { "partNumber": 1, "presignedUrl": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.txt?partNumber=1&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, { "partNumber": 2, "presignedUrl": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.txt?partNumber=2&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, { "partNumber": 3, "presignedUrl": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.txt?partNumber=3&uploadId=OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" } ] } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/files\/{fileId}\/complete": { "post": { "tags": [ "Files" ], "description": "Complete a multipart upload for a new file.", "operationId": "CompleteFileUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The fields to complete the upload.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "parts" ], "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/files\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-file.txt" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "parts": { "minItems": 1, "type": "array", "items": { "required": [ "partNumber", "eTag" ], "type": "object", "properties": { "partNumber": { "type": "integer", "example": 1 }, "eTag": { "type": "string", "example": "d41d8cd98f00b204e9800998ecf8427e" } } }, "example": [ { "partNumber": 1, "eTag": "d41d8cd98f00b204e9800998ecf8427e" }, { "partNumber": 2, "eTag": "d41d8cd98f00b204e9800998ecf8427e" }, { "partNumber": 3, "eTag": "d41d8cd98f00b204e9800998ecf8427e" } ] }, "conflictStrategy": { "enum": [ "replace", "keep-both" ], "type": "string", "nullable": false, "example": "replace" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "filename": { "type": "string", "example": "my-file.txt" }, "location": { "type": "string", "example": "\/sdcard\/files\/my_directory" }, "sizeBytes": { "type": "integer", "nullable": true, "example": 105906176 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "tag1", "tag2" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/files\/{fileId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/files\/{fileId}\/tags\/attach": { "patch": { "tags": [ "Files" ], "description": "Attach tags to a file.", "operationId": "AttachTagsToFile", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/files\/{fileId}\/tags\/detach": { "patch": { "tags": [ "Files" ], "description": "Detach tags from a file.", "operationId": "DetachTagsFromFile", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/videos": { "get": { "tags": [ "Videos" ], "description": "Get a paginated list of videos. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetVideos", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Video" }, "filename": { "type": "string", "example": "my_video.mp4" }, "location": { "type": "string", "example": "\/sdcard\/ArborXR\/videos" }, "description": { "type": "string", "nullable": true, "example": "A sample video description" }, "sizeBytes": { "type": "integer", "example": 262144000 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "details": { "type": "object", "properties": { "videoType": { "enum": [ "ThreeSixty", "OneEighty", "TwoDimensional" ], "type": "string", "example": "ThreeSixty" }, "videoMapping": { "enum": [ "EQUIRECTANGULAR", "CUBEMAP", null ], "type": "string", "nullable": true, "example": "EQUIRECTANGULAR" }, "videoDisplay": { "enum": [ "Stereoscopic", "Monoscopic", null ], "type": "string", "nullable": true, "example": "Monoscopic" }, "videoPacking": { "enum": [ "TOP_BOTTOM", "LEFT_RIGHT", null ], "type": "string", "nullable": true, "example": "TOP_BOTTOM" }, "audioEncoding": { "enum": [ "UNKNOWN", "MONO", "STEREO", "TBE_8", "TBE_8_2", "TBE_6", "TBE_6_2", "TBE_4", "TBE_4_2", "TBE_8_PAIR_0", "TBE_8_PAIR_1", "TBE_8_PAIR_2", "TBE_8_PAIR_3", "TBE_CHANNEL_0", "TBE_CHANNEL_1", "TBE_CHANNEL_2", "TBE_CHANNEL_3", "TBE_CHANNEL_4", "TBE_CHANNEL_5", "TBE_CHANNEL_6", "TBE_CHANNEL_7", "HEADLOCKED_STEREO", "HEADLOCKED_CHANNEL_0", "HEADLOCKED_CHANNEL_1", "AMBIX_4", "AMBIX_4_2", "AMBIX_9", "AMBIX_9_2", "AMBIX_16", "AMBIX_16_2" ], "type": "string", "example": "STEREO" }, "playtimeSeconds": { "type": "number", "format": "float", "nullable": true, "example": 180.5 } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "training", "demo" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/videos\/{videoId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/videos?per_page=10page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/videos?per_page=10page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/videos?per_page=10page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/videos?per_page=10page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/videos?per_page=10page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/videos" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of videos." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Videos" ], "description": "Initiate a multipart upload for a new video.", "operationId": "InitiateVideoUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "Initiate a new video upload.", "content": { "application\/json": { "schema": { "required": [ "filename", "videoType", "audioEncoding" ], "type": "object", "properties": { "filename": { "type": "string", "description": "The original filename of the video. Must end with .mp4, .mkv, or .webm", "example": "my-video.mp4" }, "videoType": { "enum": [ "ThreeSixty", "OneEighty", "TwoDimensional" ], "type": "string", "description": "The dimensional type of the video", "example": "ThreeSixty" }, "videoMapping": { "enum": [ "EQUIRECTANGULAR", "CUBEMAP", null ], "type": "string", "description": "How the 360°\/180° video content is mapped. Required for ThreeSixty and OneEighty videos, prohibited for TwoDimensional", "nullable": true, "example": "EQUIRECTANGULAR" }, "videoDisplay": { "enum": [ "Stereoscopic", "Monoscopic", null ], "type": "string", "description": "Whether the video is stereoscopic (3D) or monoscopic. Required for ThreeSixty and OneEighty videos, prohibited for TwoDimensional", "nullable": true, "example": "Stereoscopic" }, "videoPacking": { "enum": [ "TOP_BOTTOM", "LEFT_RIGHT", null ], "type": "string", "description": "How stereoscopic video content is packed. Required if videoDisplay is Stereoscopic", "nullable": true, "example": "TOP_BOTTOM" }, "audioEncoding": { "enum": [ "UNKNOWN", "MONO", "STEREO", "TBE_8", "TBE_8_2", "TBE_6", "TBE_6_2", "TBE_4", "TBE_4_2", "TBE_8_PAIR_0", "TBE_8_PAIR_1", "TBE_8_PAIR_2", "TBE_8_PAIR_3", "TBE_CHANNEL_0", "TBE_CHANNEL_1", "TBE_CHANNEL_2", "TBE_CHANNEL_3", "TBE_CHANNEL_4", "TBE_CHANNEL_5", "TBE_CHANNEL_6", "TBE_CHANNEL_7", "HEADLOCKED_STEREO", "HEADLOCKED_CHANNEL_0", "HEADLOCKED_CHANNEL_1", "AMBIX_4", "AMBIX_4_2", "AMBIX_9", "AMBIX_9_2", "AMBIX_16", "AMBIX_16_2" ], "type": "string", "description": "The audio encoding format of the video", "example": "STEREO" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "videoId" ], "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/videos\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/123e4567-e89b-12d3-a456-426614174000\/my-video.mp4" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "videoId": { "type": "string", "format": "uuid", "example": "9d6a9043-e469-4239-9cc5-147fb20905d9" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/videos\/{videoId}": { "get": { "tags": [ "Videos" ], "description": "Get a single video.", "operationId": "GetVideo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Video" }, "filename": { "type": "string", "example": "my_video.mp4" }, "location": { "type": "string", "example": "\/sdcard\/ArborXR\/videos" }, "description": { "type": "string", "nullable": true, "example": "A sample video description" }, "sizeBytes": { "type": "integer", "example": 262144000 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "details": { "type": "object", "properties": { "videoType": { "enum": [ "ThreeSixty", "OneEighty", "TwoDimensional" ], "type": "string", "example": "ThreeSixty" }, "videoMapping": { "enum": [ "EQUIRECTANGULAR", "CUBEMAP", null ], "type": "string", "nullable": true, "example": "EQUIRECTANGULAR" }, "videoDisplay": { "enum": [ "Stereoscopic", "Monoscopic", null ], "type": "string", "nullable": true, "example": "Monoscopic" }, "videoPacking": { "enum": [ "TOP_BOTTOM", "LEFT_RIGHT", null ], "type": "string", "nullable": true, "example": "TOP_BOTTOM" }, "audioEncoding": { "enum": [ "UNKNOWN", "MONO", "STEREO", "TBE_8", "TBE_8_2", "TBE_6", "TBE_6_2", "TBE_4", "TBE_4_2", "TBE_8_PAIR_0", "TBE_8_PAIR_1", "TBE_8_PAIR_2", "TBE_8_PAIR_3", "TBE_CHANNEL_0", "TBE_CHANNEL_1", "TBE_CHANNEL_2", "TBE_CHANNEL_3", "TBE_CHANNEL_4", "TBE_CHANNEL_5", "TBE_CHANNEL_6", "TBE_CHANNEL_7", "HEADLOCKED_STEREO", "HEADLOCKED_CHANNEL_0", "HEADLOCKED_CHANNEL_1", "AMBIX_4", "AMBIX_4_2", "AMBIX_9", "AMBIX_9_2", "AMBIX_16", "AMBIX_16_2" ], "type": "string", "example": "STEREO" }, "playtimeSeconds": { "type": "number", "format": "float", "nullable": true, "example": 180.5 } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "training", "demo" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/videos\/{videoId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Videos" ], "description": "Update a video.", "operationId": "UpdateVideo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Update a video", "content": { "application\/json": { "schema": { "required": [ "name", "description", "videoType", "audioEncoding", "tags" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "example": "Updated Training Video" }, "description": { "type": "string", "nullable": true, "example": "Updated description for the training video" }, "videoType": { "enum": [ "ThreeSixty", "OneEighty", "TwoDimensional" ], "type": "string", "example": "ThreeSixty" }, "videoMapping": { "enum": [ "EQUIRECTANGULAR", "CUBEMAP", null ], "type": "string", "description": "Required for ThreeSixty and OneEighty video types. Prohibited for TwoDimensional.", "nullable": true, "example": "EQUIRECTANGULAR" }, "videoDisplay": { "enum": [ "Stereoscopic", "Monoscopic", null ], "type": "string", "description": "Required for ThreeSixty and OneEighty video types. Prohibited for TwoDimensional.", "nullable": true, "example": "Monoscopic" }, "videoPacking": { "enum": [ "TOP_BOTTOM", "LEFT_RIGHT", null ], "type": "string", "description": "Required when videoDisplay is Stereoscopic. Prohibited when videoDisplay is Monoscopic.", "nullable": true, "example": "TOP_BOTTOM" }, "audioEncoding": { "enum": [ "UNKNOWN", "MONO", "STEREO", "TBE_8", "TBE_8_2", "TBE_6", "TBE_6_2", "TBE_4", "TBE_4_2", "TBE_8_PAIR_0", "TBE_8_PAIR_1", "TBE_8_PAIR_2", "TBE_8_PAIR_3", "TBE_CHANNEL_0", "TBE_CHANNEL_1", "TBE_CHANNEL_2", "TBE_CHANNEL_3", "TBE_CHANNEL_4", "TBE_CHANNEL_5", "TBE_CHANNEL_6", "TBE_CHANNEL_7", "HEADLOCKED_STEREO", "HEADLOCKED_CHANNEL_0", "HEADLOCKED_CHANNEL_1", "AMBIX_4", "AMBIX_4_2", "AMBIX_9", "AMBIX_9_2", "AMBIX_16", "AMBIX_16_2" ], "type": "string", "example": "STEREO" }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "training", "updated", "demo" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Video" }, "filename": { "type": "string", "example": "my_video.mp4" }, "location": { "type": "string", "example": "\/sdcard\/ArborXR\/videos" }, "description": { "type": "string", "nullable": true, "example": "A sample video description" }, "sizeBytes": { "type": "integer", "example": 262144000 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "details": { "type": "object", "properties": { "videoType": { "enum": [ "ThreeSixty", "OneEighty", "TwoDimensional" ], "type": "string", "example": "ThreeSixty" }, "videoMapping": { "enum": [ "EQUIRECTANGULAR", "CUBEMAP", null ], "type": "string", "nullable": true, "example": "EQUIRECTANGULAR" }, "videoDisplay": { "enum": [ "Stereoscopic", "Monoscopic", null ], "type": "string", "nullable": true, "example": "Monoscopic" }, "videoPacking": { "enum": [ "TOP_BOTTOM", "LEFT_RIGHT", null ], "type": "string", "nullable": true, "example": "TOP_BOTTOM" }, "audioEncoding": { "enum": [ "UNKNOWN", "MONO", "STEREO", "TBE_8", "TBE_8_2", "TBE_6", "TBE_6_2", "TBE_4", "TBE_4_2", "TBE_8_PAIR_0", "TBE_8_PAIR_1", "TBE_8_PAIR_2", "TBE_8_PAIR_3", "TBE_CHANNEL_0", "TBE_CHANNEL_1", "TBE_CHANNEL_2", "TBE_CHANNEL_3", "TBE_CHANNEL_4", "TBE_CHANNEL_5", "TBE_CHANNEL_6", "TBE_CHANNEL_7", "HEADLOCKED_STEREO", "HEADLOCKED_CHANNEL_0", "HEADLOCKED_CHANNEL_1", "AMBIX_4", "AMBIX_4_2", "AMBIX_9", "AMBIX_9_2", "AMBIX_16", "AMBIX_16_2" ], "type": "string", "example": "STEREO" }, "playtimeSeconds": { "type": "number", "format": "float", "nullable": true, "example": 180.5 } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "training", "demo" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/videos\/{videoId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Videos" ], "description": "Delete a video.", "operationId": "DeleteVideo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/videos\/{videoId}\/pre-sign": { "post": { "tags": [ "Videos" ], "description": "Pre-sign URLs for a multipart upload of a video.", "operationId": "PreSignVideoUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The fields to retrieve presigned URLs for video upload.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "partNumbers" ], "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/videos\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-video.mp4" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "partNumbers": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "type": "integer", "example": 1 }, "example": [ 1, 2, 3 ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "array", "items": { "required": [ "partNumber", "presignedUrl" ], "type": "object", "properties": { "partNumber": { "minimum": 1, "type": "integer", "example": 1 }, "presignedUrl": { "type": "string", "format": "uri", "example": "https:\/\/s3.amazonaws.com\/bucket\/key?AWSAccessKeyId=...&Signature=...&Expires=..." } } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/videos\/{videoId}\/complete": { "post": { "tags": [ "Videos" ], "description": "Complete a multipart upload for a video.", "operationId": "CompleteVideoUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The fields to complete the video upload.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "parts" ], "type": "object", "properties": { "key": { "type": "string", "example": "xrdm-016da47e-4c49-48ad-9c61-94904e06a226\/videos\/2f5d24ec-be98-49d3-ac42-cdecbeea40f0\/f40d390d-94fc-47a9-952c-8b7321f3eefc\/my-video.mp4" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "parts": { "minItems": 1, "type": "array", "items": { "required": [ "partNumber", "eTag" ], "type": "object", "properties": { "partNumber": { "type": "integer", "example": 1 }, "eTag": { "type": "string", "example": "d41d8cd98f00b204e9800998ecf8427e" } } }, "example": [ { "partNumber": 1, "eTag": "d41d8cd98f00b204e9800998ecf8427e" }, { "partNumber": 2, "eTag": "d41d8cd98f00b204e9800998ecf8427e" }, { "partNumber": 3, "eTag": "d41d8cd98f00b204e9800998ecf8427e" } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Video" }, "filename": { "type": "string", "example": "my_video.mp4" }, "location": { "type": "string", "example": "\/sdcard\/ArborXR\/videos" }, "description": { "type": "string", "nullable": true, "example": "A sample video description" }, "sizeBytes": { "type": "integer", "example": 262144000 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "details": { "type": "object", "properties": { "videoType": { "enum": [ "ThreeSixty", "OneEighty", "TwoDimensional" ], "type": "string", "example": "ThreeSixty" }, "videoMapping": { "enum": [ "EQUIRECTANGULAR", "CUBEMAP", null ], "type": "string", "nullable": true, "example": "EQUIRECTANGULAR" }, "videoDisplay": { "enum": [ "Stereoscopic", "Monoscopic", null ], "type": "string", "nullable": true, "example": "Monoscopic" }, "videoPacking": { "enum": [ "TOP_BOTTOM", "LEFT_RIGHT", null ], "type": "string", "nullable": true, "example": "TOP_BOTTOM" }, "audioEncoding": { "enum": [ "UNKNOWN", "MONO", "STEREO", "TBE_8", "TBE_8_2", "TBE_6", "TBE_6_2", "TBE_4", "TBE_4_2", "TBE_8_PAIR_0", "TBE_8_PAIR_1", "TBE_8_PAIR_2", "TBE_8_PAIR_3", "TBE_CHANNEL_0", "TBE_CHANNEL_1", "TBE_CHANNEL_2", "TBE_CHANNEL_3", "TBE_CHANNEL_4", "TBE_CHANNEL_5", "TBE_CHANNEL_6", "TBE_CHANNEL_7", "HEADLOCKED_STEREO", "HEADLOCKED_CHANNEL_0", "HEADLOCKED_CHANNEL_1", "AMBIX_4", "AMBIX_4_2", "AMBIX_9", "AMBIX_9_2", "AMBIX_16", "AMBIX_16_2" ], "type": "string", "example": "STEREO" }, "playtimeSeconds": { "type": "number", "format": "float", "nullable": true, "example": 180.5 } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "training", "demo" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/videos\/{videoId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/videos\/{videoId}\/tags\/attach": { "patch": { "tags": [ "Videos" ], "description": "Attach tags to a video.", "operationId": "AttachTagsToVideo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/videos\/{videoId}\/tags\/detach": { "patch": { "tags": [ "Videos" ], "description": "Detach tags from a video.", "operationId": "DetachTagsFromVideo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/images": { "get": { "tags": [ "Images" ], "description": "Get a paginated list of images. Results are ordered by `organization_id` (organization images first), `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetImages", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "type", "in": "query", "description": "The type of images to retrieve.", "required": true, "schema": { "enum": [ "unknown", "three-sixty-background", "android-wallpaper", "app-icon", "video-icon", "organization-icon", "unmanaged-app-icon", "webxr-link-icon", "headset-xp-skybox", "headset-xp-banner", "headset-xp-menu-icon" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "isSystemOwned", "type", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "isSystemOwned": { "type": "boolean", "description": "Whether this image is owned by the system (true) or by the organization (false)", "example": false }, "objectName": { "type": "string", "description": "A randomized filename used to prevent filename collisions on devices", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000.jpg" }, "originalFileName": { "type": "string", "description": "The original filename when uploaded", "nullable": true, "example": "wallpaper.jpg" }, "mimeType": { "type": "string", "description": "The MIME type of the image", "nullable": true, "example": "image\/jpeg" }, "sizeBytes": { "type": "integer", "description": "The size of the image in bytes", "nullable": true, "example": 1024000 }, "type": { "enum": [ "unknown", "three-sixty-background", "android-wallpaper", "app-icon", "video-icon", "organization-icon", "unmanaged-app-icon", "webxr-link-icon", "headset-xp-skybox", "headset-xp-banner", "headset-xp-menu-icon" ], "type": "string", "description": "The type\/category of the image", "example": "three-sixty-background" }, "status": { "enum": [ "available", "pending" ], "type": "string", "description": "The current status of the image", "example": "available" }, "downloadUrl": { "type": "string", "description": "Download URL for the image (only present when status is available)", "format": "uri", "nullable": true, "example": "https:\/\/storage.example.com\/images\/wallpaper.jpg?signature=abc123" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/images?per_page=10&page=1&type=three-sixty-background" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/images?per_page=10&page=3&type=three-sixty-background" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/images?per_page=10&page=1&type=three-sixty-background" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/images?per_page=10&page=3&type=three-sixty-background" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true }, "label": { "type": "string" }, "active": { "type": "boolean" } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/images" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of images." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Images" ], "description": "Initiate a multipart upload for a new image.", "operationId": "InitiateImageUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "Initiate a new image upload.", "content": { "application\/json": { "schema": { "required": [ "filename" ], "type": "object", "properties": { "filename": { "type": "string", "example": "wallpaper.jpg" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "key": { "type": "string", "example": "images%2F123e4567-e89b-12d3-a456-426614174000%2Fwallpaper.jpg" }, "imageId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/images\/{imageId}": { "get": { "tags": [ "Images" ], "description": "Get a single image.", "operationId": "GetImage", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "imageId", "in": "path", "description": "The ID of the image.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "isSystemOwned", "type", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "isSystemOwned": { "type": "boolean", "description": "Whether this image is owned by the system (true) or by the organization (false)", "example": false }, "objectName": { "type": "string", "description": "A randomized filename used to prevent filename collisions on devices", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000.jpg" }, "originalFileName": { "type": "string", "description": "The original filename when uploaded", "nullable": true, "example": "wallpaper.jpg" }, "mimeType": { "type": "string", "description": "The MIME type of the image", "nullable": true, "example": "image\/jpeg" }, "sizeBytes": { "type": "integer", "description": "The size of the image in bytes", "nullable": true, "example": 1024000 }, "type": { "enum": [ "unknown", "three-sixty-background", "android-wallpaper", "app-icon", "video-icon", "organization-icon", "unmanaged-app-icon", "webxr-link-icon", "headset-xp-skybox", "headset-xp-banner", "headset-xp-menu-icon" ], "type": "string", "description": "The type\/category of the image", "example": "three-sixty-background" }, "status": { "enum": [ "available", "pending" ], "type": "string", "description": "The current status of the image", "example": "available" }, "downloadUrl": { "type": "string", "description": "Download URL for the image (only present when status is available)", "format": "uri", "nullable": true, "example": "https:\/\/storage.example.com\/images\/wallpaper.jpg?signature=abc123" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/images\/{imageId}\/pre-sign": { "post": { "tags": [ "Images" ], "description": "Pre-sign URLs for a multipart upload of an image.", "operationId": "PreSignImageUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "imageId", "in": "path", "description": "The ID of the image.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Pre-sign URLs for multipart upload parts.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "partNumbers" ], "type": "object", "properties": { "key": { "type": "string", "example": "images%2F123e4567-e89b-12d3-a456-426614174000%2Fwallpaper.jpg" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "partNumbers": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "minimum": 1, "type": "integer" }, "example": [ 1, 2, 3 ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "partNumber": { "minimum": 1, "type": "integer" }, "presignedUrl": { "type": "string", "format": "uri" } } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/images\/{imageId}\/complete": { "post": { "tags": [ "Images" ], "description": "Complete a multipart upload for an image.", "operationId": "CompleteImageUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "imageId", "in": "path", "description": "The ID of the image.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Complete a multipart upload for an image.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "parts" ], "type": "object", "properties": { "key": { "type": "string", "example": "images%2F123e4567-e89b-12d3-a456-426614174000%2Fwallpaper.jpg" }, "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "parts": { "type": "array", "items": { "required": [ "partNumber", "eTag" ], "type": "object", "properties": { "partNumber": { "minimum": 1, "type": "integer" }, "eTag": { "type": "string" } } }, "example": [ { "partNumber": 1, "eTag": "d41d8cd98f00b204e9800998ecf8427e" } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "isSystemOwned", "type", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "isSystemOwned": { "type": "boolean", "description": "Whether this image is owned by the system (true) or by the organization (false)", "example": false }, "objectName": { "type": "string", "description": "A randomized filename used to prevent filename collisions on devices", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000.jpg" }, "originalFileName": { "type": "string", "description": "The original filename when uploaded", "nullable": true, "example": "wallpaper.jpg" }, "mimeType": { "type": "string", "description": "The MIME type of the image", "nullable": true, "example": "image\/jpeg" }, "sizeBytes": { "type": "integer", "description": "The size of the image in bytes", "nullable": true, "example": 1024000 }, "type": { "enum": [ "unknown", "three-sixty-background", "android-wallpaper", "app-icon", "video-icon", "organization-icon", "unmanaged-app-icon", "webxr-link-icon", "headset-xp-skybox", "headset-xp-banner", "headset-xp-menu-icon" ], "type": "string", "description": "The type\/category of the image", "example": "three-sixty-background" }, "status": { "enum": [ "available", "pending" ], "type": "string", "description": "The current status of the image", "example": "available" }, "downloadUrl": { "type": "string", "description": "Download URL for the image (only present when status is available)", "format": "uri", "nullable": true, "example": "https:\/\/storage.example.com\/images\/wallpaper.jpg?signature=abc123" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/tags": { "get": { "tags": [ "Tags" ], "description": "Get a paginated list of tags. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetTags", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "search", "in": "query", "description": "Search term to filter results.", "required": false, "schema": { "type": "string", "example": "alpha" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "stable" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/tags?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/tags?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/tags?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/tags?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/tags?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/tags" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of tags." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Tags" ], "description": "Create a new tag.", "operationId": "CreateTag", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "The tag to create.", "content": { "application\/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "example": "beta" } } } } } }, "responses": { "201": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "stable" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/tags\/{tagId}": { "get": { "tags": [ "Tags" ], "description": "Get a single tag.", "operationId": "GetTag", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "tagId", "in": "path", "description": "The ID of a tag.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "stable" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Tags" ], "description": "Update a tag.", "operationId": "UpdateTag", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "tagId", "in": "path", "description": "The ID of a tag.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tag fields to update.", "content": { "application\/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "example": "alpha" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "stable" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Tags" ], "description": "Delete a tag.", "operationId": "DeleteTag", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "tagId", "in": "path", "description": "The ID of a tag.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/device-models": { "get": { "tags": [ "Device Models" ], "description": "Get a paginated list of device models. Returns all the system's supported device models and any unsupported device models your organization has enrolled. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetDeviceModels", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/device-models?per_page=10page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/device-models?per_page=10page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/device-models?per_page=10page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/device-models?per_page=10page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/device-models?per_page=10page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/device-models" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of device models." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/device-models\/{deviceModelId}": { "get": { "tags": [ "Device Models" ], "description": "Get a single device model.", "operationId": "GetDeviceModel", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceModelId", "in": "path", "description": "The ID of a device model.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices": { "get": { "tags": [ "Devices" ], "description": "Get a paginated list of your organization's devices. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetDevices", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "state", "in": "query", "description": "Filter devices by their state. Defaults to 'active' if not specified.", "required": false, "schema": { "enum": [ "active", "suspended", "pending-factory-reset" ], "type": "string", "default": "active" } }, { "name": "tags_all[]", "in": "query", "description": "Filter devices by all of the specified tags. This parameter allows you to search for devices that have all of the provided tags. The tags should be provided as a query-parameter array. e.g. `?tags_all[]=tag1&tags_all[]=tag2`. Cannot be used with `tags_any` parameter.", "required": false, "style": "form", "explode": true, "schema": { "items": { "type": "string", "nullable": false }, "nullable": false } }, { "name": "tags_any[]", "in": "query", "description": "Filter devices by any of the specified tags. This parameter allows you to search for devices that have at least one of the provided tags. The tags should be provided as a query-parameter array. e.g. `?tags_any[]=tag1&tags_any[]=tag2`. Cannot be used with `tags_all` parameter.", "required": false, "style": "form", "explode": true, "schema": { "items": { "type": "string", "nullable": false }, "nullable": false } }, { "name": "custom_fields_all[]", "in": "query", "description": "Filter devices by all of the specified custom fields. This parameter allows you to search for devices that have all of the provided custom field values. The custom fields should be provided as a query-parameter array. e.g. `?custom_fields_all[name1]=value1&custom_fields_all[name2]=value2`. Cannot be used with `custom_fields_any` parameter.", "required": false, "schema": { "items": { "type": "string", "nullable": false }, "nullable": false } }, { "name": "custom_fields_any[]", "in": "query", "description": "Filter devices by any of the specified custom fields. This parameter allows you to search for devices that have any of the provided custom field values. The custom fields should be provided as a query-parameter array. e.g. `?custom_fields_any[name1]=value1&custom_fields_any[name2]=value2`. Cannot be used with `custom_fields_all` parameter.", "required": false, "schema": { "items": { "type": "string", "nullable": false }, "nullable": false } }, { "name": "android_versions[]", "in": "query", "description": "Filter devices by Android versions. This parameter allows you to search for devices that are running any of the provided Android versions. The Android versions should be provided as a query-parameter array. e.g. `?android_versions[]=value1&android_versions[]=value2`. Provide the full version string, e.g. `12`, `11`, or `unknown` to retrieve devices that haven't reported their version number.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string" } } }, { "name": "os_versions[]", "in": "query", "description": "Filter devices by OS versions. This parameter allows you to search for devices that are running any of the provided OS versions. The OS versions should be provided as a query-parameter array. e.g. `?os_versions[]=value1&os_versions[]=value2`. Provide the full version string, e.g. `5.13.4`, `5.12.6`, or `unknown` to retrieve devices that haven't reported their version number.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string" } } }, { "name": "client_app_versions[]", "in": "query", "description": "Filter devices by ArborXR Client App versions. This parameter allows you to search for devices that are running any of the provided client app versions. The client app versions should be provided as a query-parameter array. e.g. `?client_app_versions[]=value1&client_app_versions[]=value2`. Provide the full version string, e.g. `2025.1.0`, `2024.4.2`, or `unknown` to retrieve devices that haven't reported their version number.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string" } } }, { "name": "home_app_versions[]", "in": "query", "description": "Filter devices by ArborXR Home App versions. This parameter allows you to search for devices that are running any of the provided home app versions. The home app versions should be provided as a query-parameter array. e.g. `?home_app_versions[]=value1&home_app_versions[]=value2`. Provide the full version string, e.g. `2025.1.0`, `2024.4.2`, or `unknown` to retrieve devices that haven't reported their version number.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string" } } }, { "name": "enrollment_methods[]", "in": "query", "description": "Filter devices by enrollment methods. This parameter allows you to search for devices that were enrolled using any of the provided methods. The enrollment methods should be provided as a query-parameter array. e.g. `?enrollment_methods[]=value1&enrollment_methods[]=value2`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "enum": [ "setup-app", "meta-hms", "batch-configuration", "qr-code", "configuration-package", "unknown" ], "type": "string" } } }, { "name": "group_ids[]", "in": "query", "description": "Filter devices by group IDs (null for ungrouped devices). This parameter allows you to search for devices that belong to any of the provided groups, or sub-groups thereof. The group IDs should be provided as a query-parameter array. e.g. `?group_ids[]=value1&group_ids[]=value2`. Use an empty value to retrieve ungrouped devices. e.g. `?group_ids[]=&group_ids[]=value2`, e.g.2. `?group_ids[]=`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string", "format": "uuid", "nullable": true } } }, { "name": "device_model_ids[]", "in": "query", "description": "Filter devices by device model IDs. This parameter allows you to search for devices of any of the provided device models. The device model IDs should be provided as a query-parameter array. e.g. `?device_model_ids[]=value1&device_model_ids[]=value2`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string", "format": "uuid" } } }, { "name": "device_serial_numbers[]", "in": "query", "description": "Filter devices by device serial numbers. This parameter allows you to search for devices of any of the provided device serial numbers. The device serial numbers should be provided as a query-parameter array. e.g. `?device_serial_numbers[]=value1&device_serial_numbers[]=value2`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string" } } }, { "name": "last_online", "in": "query", "description": "Filter devices by when they were last online. This parameter allows you to search for devices based on their last online activity.", "required": false, "schema": { "enum": [ "LAST_24_HOURS", "LAST_1_TO_3_DAYS", "LAST_3_to_7_DAYS", "LAST_7_TO_14_DAYS", "LAST_14_TO_30_DAYS", "LAST_30_TO_60_DAYS", "OVER_60_DAYS", "NEVER_ONLINE" ], "type": "string" } }, { "name": "compliance_status", "in": "query", "description": "Filter devices by their compliance status. This parameter allows you to search for devices based on their compliance status.", "required": false, "schema": { "enum": [ "up-to-date", "out-of-date", "syncing", "waiting", "error" ], "type": "string" } }, { "name": "hms_modes[]", "in": "query", "description": "Filter devices by Meta Hms modes. This parameter allows you to search for devices that are in any of the provided Hms modes. The Hms modes should be provided as a query-parameter array. e.g. `?hms_modes[]=value1&hms_modes[]=value2`. Use `UNKNOWN` to find Meta Hms devices whose mode is not reported. Use `NON_APPLICABLE` to include non-Meta Hms devices.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "enum": [ "INDIVIDUAL", "SHARED", "UNKNOWN", "NON_APPLICABLE" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "name", "serialNumber", "deviceModel", "tags", "isOnline", "enrollmentDate", "customFields", "complianceStatus", "controllers", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "organization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "name": { "type": "string", "example": "Sim Station Pico" }, "serialNumber": { "type": "string", "example": "ABCDEFG1234567" }, "group": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } }, "deviceModel": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "midwest", "pico" ] }, "lastCommunicatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-21T13:22:54.000Z" }, "isOnline": { "type": "boolean", "example": true }, "clientVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "launcherVersion": { "type": "string", "nullable": true, "example": "4.5.6" }, "enrollmentDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T05:54:21.000Z" }, "systemVersion": { "type": "string", "nullable": true, "example": "8.1" }, "osVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "ssid": { "type": "string", "nullable": true, "example": "MyWiFi" }, "macAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "randomizedMacAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "storageSpaceFreeBytes": { "type": "integer", "description": "Free storage space in bytes", "format": "int64", "nullable": true, "example": 19920732160 }, "storageSpaceTotalBytes": { "type": "integer", "description": "Total storage space in bytes", "format": "int64", "nullable": true, "example": 274877906944 }, "batteryHealth": { "type": "string", "nullable": true, "example": "Good" }, "batteryCharging": { "type": "boolean", "nullable": true, "example": true }, "batteryPercentage": { "type": "integer", "nullable": true, "example": 99 }, "batteryTemperatureC": { "type": "number", "format": "float", "nullable": true, "example": 25.5 }, "ipAddress": { "type": "string", "nullable": true, "example": "10.24.58.100" }, "signalStrength": { "type": "number", "format": "float", "nullable": true, "example": 82.3 }, "frequencyMhz": { "type": "integer", "nullable": true, "example": 2437 }, "linkSpeedMbps": { "type": "integer", "nullable": true, "example": 72 }, "lastLocationLatitude": { "type": "number", "format": "float", "nullable": true, "example": 37.7749 }, "lastLocationLongitude": { "type": "number", "format": "float", "nullable": true, "example": -122.4194 }, "lastLocationAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-21T15:35:38.123Z" }, "runningApp": { "required": [ "packageName" ], "type": "object", "properties": { "packageName": { "type": "string", "description": "Android package name reported by the device.", "example": "com.arborxr.client" }, "name": { "type": "string", "description": "Human-readable app name resolved from the organization's managed apps, unmanaged apps, or a tracked-package label. Null when no such mapping exists.", "nullable": true, "example": "ArborXR Home" } }, "nullable": true }, "customFields": { "type": "array", "items": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "example": "Custom Field 1" }, "value": { "type": "string", "example": "Custom Value 1" } } } }, "complianceStatus": { "enum": [ "up-to-date", "out-of-date", "syncing", "waiting", "error" ], "type": "string", "example": "up-to-date" }, "controllers": { "type": "array", "items": { "required": [ "name", "batteryLevel", "isConnected" ], "type": "object", "properties": { "name": { "type": "string", "example": "Controller (Primary)" }, "batteryLevel": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "example": 99 }, "isConnected": { "type": "boolean", "example": true } }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.123Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of devices." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}": { "get": { "tags": [ "Devices" ], "description": "Get a single device.", "operationId": "GetDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "serialNumber", "deviceModel", "tags", "isOnline", "enrollmentDate", "customFields", "complianceStatus", "controllers", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "organization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "name": { "type": "string", "example": "Sim Station Pico" }, "serialNumber": { "type": "string", "example": "ABCDEFG1234567" }, "group": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } }, "deviceModel": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "midwest", "pico" ] }, "lastCommunicatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-21T13:22:54.000Z" }, "isOnline": { "type": "boolean", "example": true }, "clientVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "launcherVersion": { "type": "string", "nullable": true, "example": "4.5.6" }, "enrollmentDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T05:54:21.000Z" }, "systemVersion": { "type": "string", "nullable": true, "example": "8.1" }, "osVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "ssid": { "type": "string", "nullable": true, "example": "MyWiFi" }, "macAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "randomizedMacAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "storageSpaceFreeBytes": { "type": "integer", "description": "Free storage space in bytes", "format": "int64", "nullable": true, "example": 19920732160 }, "storageSpaceTotalBytes": { "type": "integer", "description": "Total storage space in bytes", "format": "int64", "nullable": true, "example": 274877906944 }, "batteryHealth": { "type": "string", "nullable": true, "example": "Good" }, "batteryCharging": { "type": "boolean", "nullable": true, "example": true }, "batteryPercentage": { "type": "integer", "nullable": true, "example": 99 }, "batteryTemperatureC": { "type": "number", "format": "float", "nullable": true, "example": 25.5 }, "ipAddress": { "type": "string", "nullable": true, "example": "10.24.58.100" }, "signalStrength": { "type": "number", "format": "float", "nullable": true, "example": 82.3 }, "frequencyMhz": { "type": "integer", "nullable": true, "example": 2437 }, "linkSpeedMbps": { "type": "integer", "nullable": true, "example": 72 }, "lastLocationLatitude": { "type": "number", "format": "float", "nullable": true, "example": 37.7749 }, "lastLocationLongitude": { "type": "number", "format": "float", "nullable": true, "example": -122.4194 }, "lastLocationAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-21T15:35:38.123Z" }, "runningApp": { "required": [ "packageName" ], "type": "object", "properties": { "packageName": { "type": "string", "description": "Android package name reported by the device.", "example": "com.arborxr.client" }, "name": { "type": "string", "description": "Human-readable app name resolved from the organization's managed apps, unmanaged apps, or a tracked-package label. Null when no such mapping exists.", "nullable": true, "example": "ArborXR Home" } }, "nullable": true }, "customFields": { "type": "array", "items": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "example": "Custom Field 1" }, "value": { "type": "string", "example": "Custom Value 1" } } } }, "complianceStatus": { "enum": [ "up-to-date", "out-of-date", "syncing", "waiting", "error" ], "type": "string", "example": "up-to-date" }, "controllers": { "type": "array", "items": { "required": [ "name", "batteryLevel", "isConnected" ], "type": "object", "properties": { "name": { "type": "string", "example": "Controller (Primary)" }, "batteryLevel": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "example": 99 }, "isConnected": { "type": "boolean", "example": true } }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.123Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Devices" ], "description": "Update a device.", "operationId": "UpdateDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The device fields to update.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "example": "Sim Station Pico" }, "groupId": { "type": "string", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "tags": { "type": "array", "items": { "type": "string", "example": "midwest" }, "example": [ "midwest", "pico" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "serialNumber", "deviceModel", "tags", "isOnline", "enrollmentDate", "customFields", "complianceStatus", "controllers", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "organization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "name": { "type": "string", "example": "Sim Station Pico" }, "serialNumber": { "type": "string", "example": "ABCDEFG1234567" }, "group": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } }, "deviceModel": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "midwest", "pico" ] }, "lastCommunicatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-21T13:22:54.000Z" }, "isOnline": { "type": "boolean", "example": true }, "clientVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "launcherVersion": { "type": "string", "nullable": true, "example": "4.5.6" }, "enrollmentDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T05:54:21.000Z" }, "systemVersion": { "type": "string", "nullable": true, "example": "8.1" }, "osVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "ssid": { "type": "string", "nullable": true, "example": "MyWiFi" }, "macAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "randomizedMacAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "storageSpaceFreeBytes": { "type": "integer", "description": "Free storage space in bytes", "format": "int64", "nullable": true, "example": 19920732160 }, "storageSpaceTotalBytes": { "type": "integer", "description": "Total storage space in bytes", "format": "int64", "nullable": true, "example": 274877906944 }, "batteryHealth": { "type": "string", "nullable": true, "example": "Good" }, "batteryCharging": { "type": "boolean", "nullable": true, "example": true }, "batteryPercentage": { "type": "integer", "nullable": true, "example": 99 }, "batteryTemperatureC": { "type": "number", "format": "float", "nullable": true, "example": 25.5 }, "ipAddress": { "type": "string", "nullable": true, "example": "10.24.58.100" }, "signalStrength": { "type": "number", "format": "float", "nullable": true, "example": 82.3 }, "frequencyMhz": { "type": "integer", "nullable": true, "example": 2437 }, "linkSpeedMbps": { "type": "integer", "nullable": true, "example": 72 }, "lastLocationLatitude": { "type": "number", "format": "float", "nullable": true, "example": 37.7749 }, "lastLocationLongitude": { "type": "number", "format": "float", "nullable": true, "example": -122.4194 }, "lastLocationAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-21T15:35:38.123Z" }, "runningApp": { "required": [ "packageName" ], "type": "object", "properties": { "packageName": { "type": "string", "description": "Android package name reported by the device.", "example": "com.arborxr.client" }, "name": { "type": "string", "description": "Human-readable app name resolved from the organization's managed apps, unmanaged apps, or a tracked-package label. Null when no such mapping exists.", "nullable": true, "example": "ArborXR Home" } }, "nullable": true }, "customFields": { "type": "array", "items": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "example": "Custom Field 1" }, "value": { "type": "string", "example": "Custom Value 1" } } } }, "complianceStatus": { "enum": [ "up-to-date", "out-of-date", "syncing", "waiting", "error" ], "type": "string", "example": "up-to-date" }, "controllers": { "type": "array", "items": { "required": [ "name", "batteryLevel", "isConnected" ], "type": "object", "properties": { "name": { "type": "string", "example": "Controller (Primary)" }, "batteryLevel": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "example": 99 }, "isConnected": { "type": "boolean", "example": true } }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.123Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/launch\/apps\/{appId}": { "post": { "tags": [ "Devices" ], "description": "Launch an app on a device. The app must be installed on the device (via a release channel assigned to the device or its group).", "operationId": "LaunchApp", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/launch\/packages\/{packageName}": { "post": { "tags": [ "Devices" ], "description": "Launch an app on a device by package name. This can be used to launch apps that are not managed in your organization (e.g. system apps).", "operationId": "LaunchPackage", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "packageName", "in": "path", "description": "The package name of an app (e.g. com.example.app).", "required": true, "schema": { "type": "string", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/launch\/videos\/{videoId}": { "post": { "tags": [ "Devices" ], "description": "Launch a video on a device. The video must be installed on the device (via a video configuration assigned to the device or its group).", "operationId": "LaunchVideo", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/fingerprint": { "post": { "tags": [ "Devices" ], "description": "Check the device fingerprint.", "operationId": "CheckFingerprint", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The fingerprint to check.", "content": { "application\/json": { "schema": { "required": [ "fingerprint" ], "type": "object", "properties": { "fingerprint": { "type": "string", "example": "d41d8cd98f00b204e9800998ecf8427e" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/statuses": { "get": { "tags": [ "Statuses" ], "description": "Get a paginated list of install\/update\/uninstall statuses for content (apps, files, videos, web-xr-links, ca-certificates, wifi-networks, meta-apps) assigned to devices in the current organization. Mirrors the portal's status page. All filters are optional.", "operationId": "GetStatuses", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "deviceIds[]", "in": "query", "description": "Filter results to one or more devices. Provide as a query-parameter array, e.g. `?deviceIds[]=value1&deviceIds[]=value2`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string", "format": "uuid" } } }, { "name": "groupIds[]", "in": "query", "description": "Filter results to devices in one or more groups. Provide as a query-parameter array, e.g. `?groupIds[]=value1&groupIds[]=value2`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string", "format": "uuid" } } }, { "name": "contentIds[]", "in": "query", "description": "Filter results to one or more pieces of content (app, file, video, etc.). Provide as a query-parameter array, e.g. `?contentIds[]=value1&contentIds[]=value2`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "type": "string", "format": "uuid" } } }, { "name": "contentTypes[]", "in": "query", "description": "Filter results to one or more content types. Provide as a query-parameter array, e.g. `?contentTypes[]=app&contentTypes[]=file`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "enum": [ "app", "file", "video", "web-xr-link", "ca-certificate", "wifi-network", "meta-app" ], "type": "string" } } }, { "name": "statuses[]", "in": "query", "description": "Filter results to one or more projected statuses. Provide as a query-parameter array, e.g. `?statuses[]=failed-install&statuses[]=failed-update`.", "required": false, "style": "form", "explode": true, "schema": { "minItems": 1, "items": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "succeeded-higher-version-installed", "failed-install", "failed-update", "failed-uninstall", "unknown" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "deviceId", "contentType", "status", "statusTimestamp", "errorDescription", "content" ], "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "contentType": { "enum": [ "app", "file", "video", "web-xr-link", "ca-certificate", "wifi-network", "meta-app" ], "type": "string", "example": "app" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "succeeded-higher-version-installed", "failed-install", "failed-update", "failed-uninstall", "unknown" ], "type": "string", "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2026-04-27T12:00:00.123Z" }, "errorDescription": { "type": "string", "description": "Human-readable description of the failure when the status is one of the failed-* values. Null otherwise.", "nullable": true, "example": "ArborXR not set as the device owner" }, "content": { "oneOf": [ { "required": [ "type", "id", "name", "packageName", "releaseChannelId", "targetVersion", "installedVersion" ], "type": "object", "properties": { "type": { "enum": [ "app" ], "type": "string", "example": "app" }, "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "nullable": true, "example": "My App" }, "packageName": { "type": "string", "nullable": true, "example": "com.example.app" }, "releaseChannelId": { "type": "string", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174002" }, "targetVersion": { "type": "string", "nullable": true, "example": "1.2.0" }, "installedVersion": { "type": "string", "nullable": true, "example": "1.1.0" } } }, { "required": [ "type", "id", "name" ], "type": "object", "properties": { "type": { "enum": [ "file" ], "type": "string", "example": "file" }, "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174003" }, "name": { "type": "string", "nullable": true, "example": "training-bundle.zip" } } }, { "required": [ "type", "id", "name" ], "type": "object", "properties": { "type": { "enum": [ "video" ], "type": "string", "example": "video" }, "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174004" }, "name": { "type": "string", "nullable": true, "example": "Onboarding Video" } } }, { "required": [ "type", "id", "name", "url" ], "type": "object", "properties": { "type": { "enum": [ "web-xr-link" ], "type": "string", "example": "web-xr-link" }, "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174005" }, "name": { "type": "string", "nullable": true, "example": "Demo Experience" }, "url": { "type": "string", "nullable": true, "example": "https:\/\/example.com\/xr-experience" } } }, { "required": [ "type", "id", "name" ], "type": "object", "properties": { "type": { "enum": [ "ca-certificate" ], "type": "string", "example": "ca-certificate" }, "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174006" }, "name": { "type": "string", "nullable": true, "example": "Corporate Root CA" } } }, { "required": [ "type", "id", "name", "ssid" ], "type": "object", "properties": { "type": { "enum": [ "wifi-network" ], "type": "string", "example": "wifi-network" }, "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174007" }, "name": { "type": "string", "nullable": true, "example": "Office Wi-Fi" }, "ssid": { "type": "string", "nullable": true, "example": "ArborXR-Office" } } }, { "required": [ "type", "id", "name", "packageName" ], "type": "object", "properties": { "type": { "enum": [ "meta-app" ], "type": "string", "example": "meta-app" }, "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174008" }, "name": { "type": "string", "nullable": true, "example": "Quest System Tool" }, "packageName": { "type": "string", "nullable": true, "example": "com.oculus.systemtool" } } } ], "discriminator": { "propertyName": "type", "mapping": { "app": ".\/DeviceContentStatus\/AppContent.json", "file": ".\/DeviceContentStatus\/FileContent.json", "video": ".\/DeviceContentStatus\/VideoContent.json", "web-xr-link": ".\/DeviceContentStatus\/WebXrLinkContent.json", "ca-certificate": ".\/DeviceContentStatus\/CaCertificateContent.json", "wifi-network": ".\/DeviceContentStatus\/WifiNetworkContent.json", "meta-app": ".\/DeviceContentStatus\/MetaAppContent.json" } } } }, "description": "The install\/update\/uninstall status of a piece of content (app, file, video, web-xr-link, ca-certificate, wifi-network, or meta-app) assigned to a device." } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/statuses?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/statuses?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/statuses?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/statuses?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/statuses?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/statuses" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of device content statuses for the current organization." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/release-channels": { "get": { "tags": [ "Devices" ], "description": "Get a paginated list of release channels assigned to a device. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetDeviceReleaseChannels", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Stable" }, "app": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } }, "version": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "bundle": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "targetVersion": { "type": "string", "example": "1.2.3" }, "installedVersion": { "type": "string", "nullable": true, "example": "1.1.1" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/apps\/{appId}\/release-channels\/{releaseChannelId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of release channels for a device." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Devices" ], "description": "Add a release channel to a device. The device must not be in a group.", "operationId": "AddReleaseChannelToDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The release channel to add to the device.", "content": { "application\/json": { "schema": { "required": [ "releaseChannelId" ], "type": "object", "properties": { "releaseChannelId": { "type": "string", "description": "The ID of the release channel to add to the device", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/release-channels\/{releaseChannelId}": { "delete": { "tags": [ "Devices" ], "description": "Remove a release channel from a device. The device must not be in a group.", "operationId": "RemoveReleaseChannelFromDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "releaseChannelId", "in": "path", "description": "The ID of a release channel.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/files": { "get": { "tags": [ "Devices" ], "description": "Get a paginated list of files assigned to a device. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetDeviceFiles", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "filename": { "type": "string", "example": "my-file.txt" }, "location": { "type": "string", "example": "\/sdcard\/files\/my_directory" }, "sizeBytes": { "type": "integer", "nullable": true, "example": 105906176 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "tag1", "tag2" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/files\/{fileId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/files?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/files?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/files?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/files?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/files?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/files" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of files for a device." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Devices" ], "description": "Add a file to a device. The device must not be in a group.", "operationId": "AddFileToDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The file to add to the device.", "content": { "application\/json": { "schema": { "required": [ "fileId" ], "type": "object", "properties": { "fileId": { "type": "string", "description": "The ID of the file to add to the device", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/files\/{fileId}": { "delete": { "tags": [ "Devices" ], "description": "Remove a file from a device. The device must not be in a group.", "operationId": "RemoveFileFromDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/videos": { "get": { "tags": [ "Devices" ], "description": "Get a paginated list of videos assigned to a device. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetDeviceVideos", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Video" }, "filename": { "type": "string", "example": "my_video.mp4" }, "location": { "type": "string", "example": "\/sdcard\/ArborXR\/videos" }, "description": { "type": "string", "nullable": true, "example": "A sample video description" }, "sizeBytes": { "type": "integer", "example": 262144000 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "details": { "type": "object", "properties": { "videoType": { "enum": [ "ThreeSixty", "OneEighty", "TwoDimensional" ], "type": "string", "example": "ThreeSixty" }, "videoMapping": { "enum": [ "EQUIRECTANGULAR", "CUBEMAP", null ], "type": "string", "nullable": true, "example": "EQUIRECTANGULAR" }, "videoDisplay": { "enum": [ "Stereoscopic", "Monoscopic", null ], "type": "string", "nullable": true, "example": "Monoscopic" }, "videoPacking": { "enum": [ "TOP_BOTTOM", "LEFT_RIGHT", null ], "type": "string", "nullable": true, "example": "TOP_BOTTOM" }, "audioEncoding": { "enum": [ "UNKNOWN", "MONO", "STEREO", "TBE_8", "TBE_8_2", "TBE_6", "TBE_6_2", "TBE_4", "TBE_4_2", "TBE_8_PAIR_0", "TBE_8_PAIR_1", "TBE_8_PAIR_2", "TBE_8_PAIR_3", "TBE_CHANNEL_0", "TBE_CHANNEL_1", "TBE_CHANNEL_2", "TBE_CHANNEL_3", "TBE_CHANNEL_4", "TBE_CHANNEL_5", "TBE_CHANNEL_6", "TBE_CHANNEL_7", "HEADLOCKED_STEREO", "HEADLOCKED_CHANNEL_0", "HEADLOCKED_CHANNEL_1", "AMBIX_4", "AMBIX_4_2", "AMBIX_9", "AMBIX_9_2", "AMBIX_16", "AMBIX_16_2" ], "type": "string", "example": "STEREO" }, "playtimeSeconds": { "type": "number", "format": "float", "nullable": true, "example": 180.5 } } }, "tags": { "type": "array", "items": { "type": "string", "nullable": false }, "example": [ "training", "demo" ] }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/videos\/{videoId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2001-02-03T01:23:45.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/videos?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/videos?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/videos?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/videos?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/videos?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/devices\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/videos" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of videos for a device." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Devices" ], "description": "Add a video to a device. The device must not be in a group.", "operationId": "AddVideoToDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The video to add to the device.", "content": { "application\/json": { "schema": { "required": [ "videoId" ], "type": "object", "properties": { "videoId": { "type": "string", "description": "The ID of the video to add to the device", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/videos\/{videoId}": { "delete": { "tags": [ "Devices" ], "description": "Remove a video from a device. The device must not be in a group.", "operationId": "RemoveVideoFromDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/reboot": { "post": { "tags": [ "Devices" ], "description": "Reboot a device.", "operationId": "RebootDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/shut-down": { "post": { "tags": [ "Devices" ], "description": "Shut down a device.", "operationId": "ShutDownDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/factory-reset": { "post": { "tags": [ "Devices" ], "description": "Factory reset a device.", "operationId": "FactoryResetDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/migrate\/{organizationSlug}": { "post": { "tags": [ "Devices" ], "description": "Migrate a device to another organization.", "operationId": "MigrateDeviceToOrganization", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "organizationSlug", "in": "path", "description": "The slug for the organization", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Migrate device to organization request", "content": { "application\/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string", "description": "ID of the configured group in the target organization to assign the device to", "format": "uuid", "nullable": true } } } } }, "required": true }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/tags\/attach": { "patch": { "tags": [ "Devices" ], "description": "Attach tags to a device.", "operationId": "AttachTagsToDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/tags\/detach": { "patch": { "tags": [ "Devices" ], "description": "Detach tags from a device.", "operationId": "DetachTagsFromDevice", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/custom-fields": { "patch": { "tags": [ "Devices" ], "description": "Update custom fields on a device. Supports attach, detach, and sync actions.", "operationId": "UpdateDeviceCustomFields", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Update custom fields on a device", "content": { "application\/json": { "schema": { "required": [ "action", "customFields" ], "type": "object", "properties": { "action": { "enum": [ "attach", "detach", "sync" ], "type": "string", "description": "The action to perform on the custom fields" }, "customFields": { "type": "array", "items": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the custom field" }, "value": { "type": "string", "description": "The value of the custom field (required for attach and sync actions)" } } }, "description": "Array of custom fields to attach, detach, or sync" } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "serialNumber", "deviceModel", "tags", "isOnline", "enrollmentDate", "customFields", "complianceStatus", "controllers", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "organization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "name": { "type": "string", "example": "Sim Station Pico" }, "serialNumber": { "type": "string", "example": "ABCDEFG1234567" }, "group": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } }, "deviceModel": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "midwest", "pico" ] }, "lastCommunicatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-21T13:22:54.000Z" }, "isOnline": { "type": "boolean", "example": true }, "clientVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "launcherVersion": { "type": "string", "nullable": true, "example": "4.5.6" }, "enrollmentDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T05:54:21.000Z" }, "systemVersion": { "type": "string", "nullable": true, "example": "8.1" }, "osVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "ssid": { "type": "string", "nullable": true, "example": "MyWiFi" }, "macAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "randomizedMacAddress": { "type": "string", "nullable": true, "example": "00:11:22:33:44:55" }, "storageSpaceFreeBytes": { "type": "integer", "description": "Free storage space in bytes", "format": "int64", "nullable": true, "example": 19920732160 }, "storageSpaceTotalBytes": { "type": "integer", "description": "Total storage space in bytes", "format": "int64", "nullable": true, "example": 274877906944 }, "batteryHealth": { "type": "string", "nullable": true, "example": "Good" }, "batteryCharging": { "type": "boolean", "nullable": true, "example": true }, "batteryPercentage": { "type": "integer", "nullable": true, "example": 99 }, "batteryTemperatureC": { "type": "number", "format": "float", "nullable": true, "example": 25.5 }, "ipAddress": { "type": "string", "nullable": true, "example": "10.24.58.100" }, "signalStrength": { "type": "number", "format": "float", "nullable": true, "example": 82.3 }, "frequencyMhz": { "type": "integer", "nullable": true, "example": 2437 }, "linkSpeedMbps": { "type": "integer", "nullable": true, "example": 72 }, "lastLocationLatitude": { "type": "number", "format": "float", "nullable": true, "example": 37.7749 }, "lastLocationLongitude": { "type": "number", "format": "float", "nullable": true, "example": -122.4194 }, "lastLocationAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-21T15:35:38.123Z" }, "runningApp": { "required": [ "packageName" ], "type": "object", "properties": { "packageName": { "type": "string", "description": "Android package name reported by the device.", "example": "com.arborxr.client" }, "name": { "type": "string", "description": "Human-readable app name resolved from the organization's managed apps, unmanaged apps, or a tracked-package label. Null when no such mapping exists.", "nullable": true, "example": "ArborXR Home" } }, "nullable": true }, "customFields": { "type": "array", "items": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "example": "Custom Field 1" }, "value": { "type": "string", "example": "Custom Value 1" } } } }, "complianceStatus": { "enum": [ "up-to-date", "out-of-date", "syncing", "waiting", "error" ], "type": "string", "example": "up-to-date" }, "controllers": { "type": "array", "items": { "required": [ "name", "batteryLevel", "isConnected" ], "type": "object", "properties": { "name": { "type": "string", "example": "Controller (Primary)" }, "batteryLevel": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "example": 99 }, "isConnected": { "type": "boolean", "example": true } }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "description": "Currently, only PICO & Meta Hms devices report this data." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.123Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/themes": { "get": { "tags": [ "Themes" ], "description": "Get a paginated list of themes. Results include both organization themes and system themes, ordered with system themes first, then by name.", "operationId": "GetThemes", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "name", "isSystemOwned", "background1", "background2", "text", "accent1", "accent2", "accent3" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the theme", "example": "Dark Theme" }, "isSystemOwned": { "type": "boolean", "description": "Whether this theme is owned by the system (true) or by the organization (false)", "example": false }, "background1": { "type": "string", "description": "Primary background color (hex format)", "example": "#1a1a1a" }, "background2": { "type": "string", "description": "Secondary background color (hex format)", "example": "#2a2a2a" }, "text": { "type": "string", "description": "Text color (hex format)", "example": "#ffffff" }, "accent1": { "type": "string", "description": "Primary accent color (hex format)", "example": "#007bff" }, "accent2": { "type": "string", "description": "Secondary accent color (hex format)", "example": "#28a745" }, "accent3": { "type": "string", "description": "Tertiary accent color (hex format)", "example": "#dc3545" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/themes?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/themes?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/themes?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/themes?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true }, "label": { "type": "string" }, "active": { "type": "boolean" } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/themes" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of themes." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Themes" ], "description": "Create a new theme.", "operationId": "CreateTheme", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "Create a new theme.", "content": { "application\/json": { "schema": { "required": [ "name", "background1", "background2", "text", "accent1", "accent2", "accent3" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the theme", "example": "Dark Theme" }, "background1": { "type": "string", "description": "Primary background color (hex format)", "example": "#1a1a1a" }, "background2": { "type": "string", "description": "Secondary background color (hex format)", "example": "#2a2a2a" }, "text": { "type": "string", "description": "Text color (hex format)", "example": "#ffffff" }, "accent1": { "type": "string", "description": "Primary accent color (hex format)", "example": "#007bff" }, "accent2": { "type": "string", "description": "Secondary accent color (hex format)", "example": "#28a745" }, "accent3": { "type": "string", "description": "Tertiary accent color (hex format)", "example": "#dc3545" } } } } } }, "responses": { "201": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isSystemOwned", "background1", "background2", "text", "accent1", "accent2", "accent3" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the theme", "example": "Dark Theme" }, "isSystemOwned": { "type": "boolean", "description": "Whether this theme is owned by the system (true) or by the organization (false)", "example": false }, "background1": { "type": "string", "description": "Primary background color (hex format)", "example": "#1a1a1a" }, "background2": { "type": "string", "description": "Secondary background color (hex format)", "example": "#2a2a2a" }, "text": { "type": "string", "description": "Text color (hex format)", "example": "#ffffff" }, "accent1": { "type": "string", "description": "Primary accent color (hex format)", "example": "#007bff" }, "accent2": { "type": "string", "description": "Secondary accent color (hex format)", "example": "#28a745" }, "accent3": { "type": "string", "description": "Tertiary accent color (hex format)", "example": "#dc3545" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/themes\/{themeId}": { "get": { "tags": [ "Themes" ], "description": "Get a single theme.", "operationId": "GetTheme", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "themeId", "in": "path", "description": "The ID of the theme.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isSystemOwned", "background1", "background2", "text", "accent1", "accent2", "accent3" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the theme", "example": "Dark Theme" }, "isSystemOwned": { "type": "boolean", "description": "Whether this theme is owned by the system (true) or by the organization (false)", "example": false }, "background1": { "type": "string", "description": "Primary background color (hex format)", "example": "#1a1a1a" }, "background2": { "type": "string", "description": "Secondary background color (hex format)", "example": "#2a2a2a" }, "text": { "type": "string", "description": "Text color (hex format)", "example": "#ffffff" }, "accent1": { "type": "string", "description": "Primary accent color (hex format)", "example": "#007bff" }, "accent2": { "type": "string", "description": "Secondary accent color (hex format)", "example": "#28a745" }, "accent3": { "type": "string", "description": "Tertiary accent color (hex format)", "example": "#dc3545" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Themes" ], "description": "Update a theme. System themes cannot be modified.", "operationId": "UpdateTheme", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "themeId", "in": "path", "description": "The ID of the theme.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Update a theme.", "content": { "application\/json": { "schema": { "required": [ "name", "background1", "background2", "text", "accent1", "accent2", "accent3" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the theme", "example": "Dark Theme" }, "background1": { "type": "string", "description": "Primary background color (hex format)", "example": "#1a1a1a" }, "background2": { "type": "string", "description": "Secondary background color (hex format)", "example": "#2a2a2a" }, "text": { "type": "string", "description": "Text color (hex format)", "example": "#ffffff" }, "accent1": { "type": "string", "description": "Primary accent color (hex format)", "example": "#007bff" }, "accent2": { "type": "string", "description": "Secondary accent color (hex format)", "example": "#28a745" }, "accent3": { "type": "string", "description": "Tertiary accent color (hex format)", "example": "#dc3545" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isSystemOwned", "background1", "background2", "text", "accent1", "accent2", "accent3" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the theme", "example": "Dark Theme" }, "isSystemOwned": { "type": "boolean", "description": "Whether this theme is owned by the system (true) or by the organization (false)", "example": false }, "background1": { "type": "string", "description": "Primary background color (hex format)", "example": "#1a1a1a" }, "background2": { "type": "string", "description": "Secondary background color (hex format)", "example": "#2a2a2a" }, "text": { "type": "string", "description": "Text color (hex format)", "example": "#ffffff" }, "accent1": { "type": "string", "description": "Primary accent color (hex format)", "example": "#007bff" }, "accent2": { "type": "string", "description": "Secondary accent color (hex format)", "example": "#28a745" }, "accent3": { "type": "string", "description": "Tertiary accent color (hex format)", "example": "#dc3545" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Themes" ], "description": "Delete a theme. System themes cannot be deleted.", "operationId": "DeleteTheme", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "themeId", "in": "path", "description": "The ID of the theme.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/audit-logs": { "get": { "tags": [ "Audit Logs" ], "description": "Get a paginated list of audit logs for the organization.", "operationId": "GetAuditLogs", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } }, { "name": "search", "in": "query", "description": "Search term to filter results.", "required": false, "schema": { "type": "string", "example": "alpha" } }, { "name": "start_time", "in": "query", "description": "Filter to show only entries created at or after this timestamp (ISO 8601 Zulu format with millisecond precision).", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00.000Z" } }, { "name": "end_time", "in": "query", "description": "Filter to show only entries created at or before this timestamp (ISO 8601 Zulu format with millisecond precision).", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2024-12-31T23:59:59.999Z" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "description", "action", "type", "userEmail", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the audit log entry.", "example": 1 }, "description": { "type": "string", "description": "Human-readable description of the action performed.", "example": "User updated device settings" }, "action": { "type": "string", "description": "The specific action that was performed.", "example": "update-device" }, "type": { "enum": [ "created", "read", "updated", "deleted", "remote_action", "exported" ], "type": "string", "description": "The type of action or category.", "example": "updated" }, "resourceId": { "type": "string", "description": "The unique identifier of the resource that was acted upon.", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "resourceType": { "type": "string", "description": "The type of resource that was acted upon (e.g., 'device', 'user').", "nullable": true, "example": "device" }, "resourceName": { "type": "string", "description": "The name of the resource that was acted upon.", "nullable": true, "example": "My Device (S3R!4L-NUMB3R)" }, "userId": { "type": "string", "description": "The unique identifier of the user.", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "userEmail": { "type": "string", "description": "The email address of the user, or 'System' for system actions, or 'ArborXR' for admin\/impersonation actions.", "example": "user@example.com" }, "userIpAddress": { "type": "string", "description": "IP address from which the action was performed.", "nullable": true, "example": "192.168.1.100" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-15T14:30:00.000Z" } }, "description": "An audit log entry representing an action performed in the system." } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/audit-logs?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/audit-logs?per_page=10&page=5" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/audit-logs?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/audit-logs?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 5 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/audit-logs?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/audit-logs" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 47 } } } }, "description": "A paginated list of audit logs." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/app-usage": { "get": { "tags": [ "Analytics" ], "description": "Get app usage statistics for your organization.", "operationId": "GetAppUsage", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "start_date", "in": "query", "description": "The start date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" } }, { "name": "end_date", "in": "query", "description": "The end date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-12-31" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the app.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the app.", "example": "Example App" } } }, "totalSessions": { "type": "integer", "description": "The total number of sessions for the app within the specified date range.", "example": 15 }, "totalSessionDuration": { "type": "integer", "description": "The total duration of all sessions for the app within the specified date range, in seconds.", "example": 3600 }, "totalIdleDuration": { "type": "integer", "description": "The total duration of idle time for the app within the specified date range, in seconds.", "example": 600 }, "totalActiveDuration": { "type": "integer", "description": "The total duration of active time for the app within the specified date range, in seconds.", "example": 3000 }, "averageActiveDuration": { "type": "integer", "description": "The average duration of active time per session for the app within the specified date range, in seconds.", "example": 200 }, "maxActiveDuration": { "type": "integer", "description": "The maximum duration of active time for a single session of the app within the specified date range, in seconds.", "example": 600 } }, "description": "App usage statistics for a specific app within a date range." } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-usage" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of app usage statistics." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/app-sessions\/{appId}": { "get": { "tags": [ "Analytics" ], "description": "Get a paginated list of app sessions for a specific app within your organization.", "operationId": "GetAppSessions", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "start_date", "in": "query", "description": "The start date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" } }, { "name": "end_date", "in": "query", "description": "The end date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-12-31" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the app session.", "format": "uuid", "example": "f9bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "totalDuration": { "type": "integer", "description": "The total duration of the app session in seconds.", "example": 3600 }, "idleDuration": { "type": "integer", "description": "The idle duration of the app session in seconds.", "example": 600 }, "activeDuration": { "type": "integer", "description": "The active duration of the app session in seconds.", "example": 3000 }, "startedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T10:00:00.000Z" }, "endedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T11:00:00.000Z" }, "device": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the device.", "format": "uuid", "example": "d3bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "name": { "type": "string", "description": "The name of the device.", "example": "Device A" }, "serial": { "type": "string", "description": "The serial number of the device.", "example": "ABC123456" }, "group": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the device group.", "format": "uuid", "example": "e3bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "name": { "type": "string", "description": "The name of the device group.", "example": "Group A" } }, "description": "The group the device belongs to, if any.", "nullable": true } }, "description": "Details of the device used for the app session." }, "app": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the app.", "format": "uuid", "example": "a2bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "name": { "type": "string", "description": "The name of the app.", "example": "Example App" }, "packageName": { "type": "string", "description": "The package name of the app.", "example": "com.example.app" }, "version": { "type": "string", "description": "The version name of the app.", "example": "1.0.0" }, "versionCode": { "type": "string", "description": "The version code of the app.", "example": "1" } }, "description": "Details of the app associated with the session." } }, "description": "An individual app session representing usage of an app on a device." } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/app-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/app-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of app sessions." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/shared-app-usage": { "get": { "tags": [ "Analytics" ], "description": "Get app usage statistics for apps shared by your organization.", "operationId": "GetSharedAppUsages", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "start_date", "in": "query", "description": "The start date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" } }, { "name": "end_date", "in": "query", "description": "The end date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-12-31" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the app.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the app.", "example": "Example App" } } }, "totalSessions": { "type": "integer", "description": "The total number of sessions for the app within the specified date range.", "example": 15 }, "totalSessionDuration": { "type": "integer", "description": "The total duration of all sessions for the app within the specified date range, in seconds.", "example": 3600 }, "totalIdleDuration": { "type": "integer", "description": "The total duration of idle time for the app within the specified date range, in seconds.", "example": 600 }, "totalActiveDuration": { "type": "integer", "description": "The total duration of active time for the app within the specified date range, in seconds.", "example": 3000 }, "averageActiveDuration": { "type": "integer", "description": "The average duration of active time per session for the app within the specified date range, in seconds.", "example": 200 }, "maxActiveDuration": { "type": "integer", "description": "The maximum duration of active time for a single session of the app within the specified date range, in seconds.", "example": 600 } }, "description": "App usage statistics for a specific app within a date range." } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/shared-app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/shared-app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/shared-app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/shared-app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/shared-app-usage?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/shared-app-usage" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of shared app usage statistics." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/shared-app-usage\/{appId}": { "get": { "tags": [ "Analytics" ], "description": "Get an app usage summary for a specific app shared by your organization.", "operationId": "GetSharedAppUsage", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "start_date", "in": "query", "description": "The start date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" } }, { "name": "end_date", "in": "query", "description": "The end date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-12-31" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "app": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the app.", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "description": "The name of the app.", "example": "Example App" } } }, "totalSessions": { "type": "integer", "description": "The total number of sessions for the app within the specified date range.", "example": 15 }, "totalSessionDuration": { "type": "integer", "description": "The total duration of all sessions for the app within the specified date range, in seconds.", "example": 3600 }, "totalIdleDuration": { "type": "integer", "description": "The total duration of idle time for the app within the specified date range, in seconds.", "example": 600 }, "totalActiveDuration": { "type": "integer", "description": "The total duration of active time for the app within the specified date range, in seconds.", "example": 3000 }, "averageActiveDuration": { "type": "integer", "description": "The average duration of active time per session for the app within the specified date range, in seconds.", "example": 200 }, "maxActiveDuration": { "type": "integer", "description": "The maximum duration of active time for a single session of the app within the specified date range, in seconds.", "example": 600 } }, "description": "App usage statistics for a specific app within a date range." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/device-sessions\/{deviceId}": { "get": { "tags": [ "Analytics" ], "description": "Get a paginated list of app sessions for a specific device within your organization.", "operationId": "GetDeviceSessions", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "start_date", "in": "query", "description": "The start date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-01-01" } }, { "name": "end_date", "in": "query", "description": "The end date bound for the query, in ISO 8601 format (YYYY-MM-DD).", "required": true, "schema": { "type": "string", "format": "date", "example": "2025-12-31" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the app session.", "format": "uuid", "example": "f9bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "totalDuration": { "type": "integer", "description": "The total duration of the app session in seconds.", "example": 3600 }, "idleDuration": { "type": "integer", "description": "The idle duration of the app session in seconds.", "example": 600 }, "activeDuration": { "type": "integer", "description": "The active duration of the app session in seconds.", "example": 3000 }, "startedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T10:00:00.000Z" }, "endedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2025-01-15T11:00:00.000Z" }, "device": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the device.", "format": "uuid", "example": "d3bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "name": { "type": "string", "description": "The name of the device.", "example": "Device A" }, "serial": { "type": "string", "description": "The serial number of the device.", "example": "ABC123456" }, "group": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the device group.", "format": "uuid", "example": "e3bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "name": { "type": "string", "description": "The name of the device group.", "example": "Group A" } }, "description": "The group the device belongs to, if any.", "nullable": true } }, "description": "Details of the device used for the app session." }, "app": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the app.", "format": "uuid", "example": "a2bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "name": { "type": "string", "description": "The name of the app.", "example": "Example App" }, "packageName": { "type": "string", "description": "The package name of the app.", "example": "com.example.app" }, "version": { "type": "string", "description": "The version name of the app.", "example": "1.0.0" }, "versionCode": { "type": "string", "description": "The version code of the app.", "example": "1" } }, "description": "Details of the app associated with the session." } }, "description": "An individual app session representing usage of an app on a device." } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/device-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/device-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/device-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/device-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/device-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25?start_date=2025-01-01&end_date=2025-12-31&per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/device-sessions\/9bfc9a97-fd25-47fd-899c-d21ed6e33b25" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of app sessions for a device." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/headset-experience\/arborxr-home": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the ArborXR Home headset experience for a group.", "operationId": "ConfigureGroupArborXrHomeHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the ArborXR Home headset experience.", "content": { "application\/json": { "schema": { "required": [ "visibleContents", "language", "menuTitle", "menuIconImageId", "removePoweredByArborXrBranding", "shortcuts", "adminPin", "categorizationTags", "background", "themeId" ], "type": "object", "properties": { "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the content item", "format": "uuid" }, "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string", "description": "Type of content" } } }, "description": "Array of content items visible in the ArborXR Home experience", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "video" } ] }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "description": "Language for the headset experience", "example": "en" }, "menuTitle": { "maxLength": 255, "type": "string", "description": "Title displayed in the menu", "example": "My Stuff" }, "menuIconImageId": { "type": "string", "description": "UUID of the image to use as menu icon", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "removePoweredByArborXrBranding": { "type": "boolean", "description": "Whether to remove 'Powered by ArborXR' branding", "example": false }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment" ], "type": "string" }, "description": "Array of shortcuts to enable", "example": [ "boundary", "screencast", "screen-capture" ] }, "adminPin": { "pattern": "^[0-9]{4,10}$", "type": "string", "description": "Numeric admin PIN (4-10 digits)", "nullable": true, "example": "1234" }, "categorizationTags": { "type": "array", "items": { "maxLength": 60, "type": "string" }, "description": "Array of tags for categorization", "example": [ "training", "development", "sales" ] }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string", "description": "Type of background environment" }, "bannerImageId": { "type": "string", "description": "UUID of banner image (required when `type` is `3d-model`)", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "UUID of skybox image (required when `type` is `3d-model`)", "format": "uuid" }, "threeSixtyImageId": { "type": "string", "description": "UUID of 360-degree background image (required when `type` is `360-background`)", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "UUID of custom 3D environment (required when `type` is `custom-3d-environment`)", "format": "uuid" } }, "example": { "type": "3d-model", "bannerImageId": "123e4567-e89b-12d3-a456-426614174000", "skyboxImageId": "123e4567-e89b-12d3-a456-426614174001" } }, "themeId": { "type": "string", "description": "UUID of the theme to apply", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "sharedModeSettings": { "required": [ "enableOfflineMode", "requireManagedMetaLogin", "enableControllerFree", "adjustDeviceFit", "defaultToStationaryBoundary" ], "type": "object", "properties": { "enableOfflineMode": { "type": "boolean", "description": "Whether to enable offline mode", "example": true }, "requireManagedMetaLogin": { "type": "boolean", "description": "Whether to require managed Meta login", "example": false }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level. Use this instead of requireSessionPasscode.", "nullable": true, "example": "NONE" }, "requireSessionPasscode": { "type": "boolean", "description": "Deprecated. Use requiredPasswordComplexity instead. true maps to LOW, false maps to NONE.", "example": false, "deprecated": true }, "sessionTimeout": { "enum": [ "FIFTEEN", "THIRTY", "FORTY_FIVE", "SIXTY" ], "type": "string", "description": "Deprecated. Session timeout in minutes.", "example": "THIRTY", "deprecated": true }, "enableControllerFree": { "type": "boolean", "description": "Whether to enable controller-free mode", "example": false }, "wakeControllers": { "type": "boolean", "description": "Whether to wake controllers (required when `enableControllerFree` is `false`)", "example": true }, "adjustDeviceFit": { "type": "boolean", "description": "Whether to adjust device fit", "example": true }, "defaultToStationaryBoundary": { "type": "boolean", "description": "Whether to default to stationary boundary", "example": false } }, "description": "Shared mode settings (required for Groups and Meta HMS devices)" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/headset-experience\/arborxr-home": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the ArborXR Home headset experience for a device.", "operationId": "ConfigureDeviceArborXrHomeHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the ArborXR Home headset experience.", "content": { "application\/json": { "schema": { "required": [ "visibleContents", "language", "menuTitle", "menuIconImageId", "removePoweredByArborXrBranding", "shortcuts", "adminPin", "categorizationTags", "background", "themeId" ], "type": "object", "properties": { "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the content item", "format": "uuid" }, "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string", "description": "Type of content" } } }, "description": "Array of content items visible in the ArborXR Home experience", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "video" } ] }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "description": "Language for the headset experience", "example": "en" }, "menuTitle": { "maxLength": 255, "type": "string", "description": "Title displayed in the menu", "example": "My Stuff" }, "menuIconImageId": { "type": "string", "description": "UUID of the image to use as menu icon", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "removePoweredByArborXrBranding": { "type": "boolean", "description": "Whether to remove 'Powered by ArborXR' branding", "example": false }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment" ], "type": "string" }, "description": "Array of shortcuts to enable", "example": [ "boundary", "screencast", "screen-capture" ] }, "adminPin": { "pattern": "^[0-9]{4,10}$", "type": "string", "description": "Numeric admin PIN (4-10 digits)", "nullable": true, "example": "1234" }, "categorizationTags": { "type": "array", "items": { "maxLength": 60, "type": "string" }, "description": "Array of tags for categorization", "example": [ "training", "development", "sales" ] }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string", "description": "Type of background environment" }, "bannerImageId": { "type": "string", "description": "UUID of banner image (required when `type` is `3d-model`)", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "UUID of skybox image (required when `type` is `3d-model`)", "format": "uuid" }, "threeSixtyImageId": { "type": "string", "description": "UUID of 360-degree background image (required when `type` is `360-background`)", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "UUID of custom 3D environment (required when `type` is `custom-3d-environment`)", "format": "uuid" } }, "example": { "type": "3d-model", "bannerImageId": "123e4567-e89b-12d3-a456-426614174000", "skyboxImageId": "123e4567-e89b-12d3-a456-426614174001" } }, "themeId": { "type": "string", "description": "UUID of the theme to apply", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "sharedModeSettings": { "required": [ "enableOfflineMode", "requireManagedMetaLogin", "enableControllerFree", "adjustDeviceFit", "defaultToStationaryBoundary" ], "type": "object", "properties": { "enableOfflineMode": { "type": "boolean", "description": "Whether to enable offline mode", "example": true }, "requireManagedMetaLogin": { "type": "boolean", "description": "Whether to require managed Meta login", "example": false }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level. Use this instead of requireSessionPasscode.", "nullable": true, "example": "NONE" }, "requireSessionPasscode": { "type": "boolean", "description": "Deprecated. Use requiredPasswordComplexity instead. true maps to LOW, false maps to NONE.", "example": false, "deprecated": true }, "sessionTimeout": { "enum": [ "FIFTEEN", "THIRTY", "FORTY_FIVE", "SIXTY" ], "type": "string", "description": "Deprecated. Session timeout in minutes.", "example": "THIRTY", "deprecated": true }, "enableControllerFree": { "type": "boolean", "description": "Whether to enable controller-free mode", "example": false }, "wakeControllers": { "type": "boolean", "description": "Whether to wake controllers (required when `enableControllerFree` is `false`)", "example": true }, "adjustDeviceFit": { "type": "boolean", "description": "Whether to adjust device fit", "example": true }, "defaultToStationaryBoundary": { "type": "boolean", "description": "Whether to default to stationary boundary", "example": false } }, "description": "Shared mode settings (required for Groups and Meta HMS devices)" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/headset-experience\/arborxr-kiosk": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the ArborXR Kiosk headset experience for a group.", "operationId": "ConfigureGroupArborXrKioskHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the ArborXR Kiosk headset experience.", "content": { "application\/json": { "schema": { "required": [ "kioskContent", "isMenuEnabled" ], "type": "object", "properties": { "kioskContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "web-xr-link", "video" ], "type": "string", "description": "Type of kiosk content" }, "id": { "type": "string", "description": "UUID of the content item", "format": "uuid" } }, "description": "The content to display in kiosk mode", "example": { "type": "app", "id": "123e4567-e89b-12d3-a456-426614174000" } }, "isMenuEnabled": { "type": "boolean", "description": "Whether to enable the menu in kiosk mode", "example": true }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "description": "Language for the headset experience (required when isMenuEnabled is true)", "example": "en" }, "menuIconImageId": { "type": "string", "description": "UUID of the image to use as menu icon (required when isMenuEnabled is true)", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "removePoweredByArborXrBranding": { "type": "boolean", "description": "Whether to remove 'Powered by ArborXR' branding (required when isMenuEnabled is true)", "example": false }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment" ], "type": "string" }, "description": "Array of shortcuts to enable (present when isMenuEnabled is true)", "example": [ "boundary", "screencast" ] }, "adminPin": { "pattern": "^[0-9]{4,10}$", "type": "string", "description": "Numeric admin PIN (4-10 digits, present when isMenuEnabled is true)", "nullable": true, "example": "1234" }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string", "description": "Type of background environment" }, "bannerImageId": { "type": "string", "description": "UUID of banner image (required when type is 3d-model)", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "UUID of skybox image (required when type is 3d-model)", "format": "uuid" }, "threeSixtyImageId": { "type": "string", "description": "UUID of 360-degree background image (required when type is 360-background)", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "UUID of custom 3D environment (required when type is custom-3d-environment)", "format": "uuid" } }, "description": "Background settings (required when isMenuEnabled is true)", "example": { "type": "360-background", "threeSixtyImageId": "123e4567-e89b-12d3-a456-426614174000" } }, "themeId": { "type": "string", "description": "UUID of the theme to apply (required when isMenuEnabled is true)", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "sharedModeSettings": { "required": [ "enableOfflineMode", "requireManagedMetaLogin", "enableControllerFree", "adjustDeviceFit", "defaultToStationaryBoundary" ], "type": "object", "properties": { "enableOfflineMode": { "type": "boolean", "description": "Whether to enable offline mode", "example": true }, "requireManagedMetaLogin": { "type": "boolean", "description": "Whether to require managed Meta login", "example": false }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level. Use this instead of requireSessionPasscode.", "nullable": true, "example": "NONE" }, "requireSessionPasscode": { "type": "boolean", "description": "Deprecated. Use requiredPasswordComplexity instead. true maps to LOW, false maps to NONE.", "example": false, "deprecated": true }, "sessionTimeout": { "enum": [ "FIFTEEN", "THIRTY", "FORTY_FIVE", "SIXTY" ], "type": "string", "description": "Deprecated. Session timeout in minutes.", "example": "THIRTY", "deprecated": true }, "enableControllerFree": { "type": "boolean", "description": "Whether to enable controller-free mode", "example": false }, "wakeControllers": { "type": "boolean", "description": "Whether to wake controllers (required when enableControllerFree is false)", "example": true }, "adjustDeviceFit": { "type": "boolean", "description": "Whether to adjust device fit", "example": true }, "defaultToStationaryBoundary": { "type": "boolean", "description": "Whether to default to stationary boundary", "example": false } }, "description": "Shared mode settings (required for Groups and Meta HMS devices)" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/headset-experience\/arborxr-kiosk": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the ArborXR Kiosk headset experience for a device.", "operationId": "ConfigureDeviceArborXrKioskHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the ArborXR Kiosk headset experience.", "content": { "application\/json": { "schema": { "required": [ "kioskContent", "isMenuEnabled" ], "type": "object", "properties": { "kioskContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "web-xr-link", "video" ], "type": "string", "description": "Type of kiosk content" }, "id": { "type": "string", "description": "UUID of the content item", "format": "uuid" } }, "description": "The content to display in kiosk mode", "example": { "type": "app", "id": "123e4567-e89b-12d3-a456-426614174000" } }, "isMenuEnabled": { "type": "boolean", "description": "Whether to enable the menu in kiosk mode", "example": true }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "description": "Language for the headset experience (required when isMenuEnabled is true)", "example": "en" }, "menuIconImageId": { "type": "string", "description": "UUID of the image to use as menu icon (required when isMenuEnabled is true)", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "removePoweredByArborXrBranding": { "type": "boolean", "description": "Whether to remove 'Powered by ArborXR' branding (required when isMenuEnabled is true)", "example": false }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment" ], "type": "string" }, "description": "Array of shortcuts to enable (present when isMenuEnabled is true)", "example": [ "boundary", "screencast" ] }, "adminPin": { "pattern": "^[0-9]{4,10}$", "type": "string", "description": "Numeric admin PIN (4-10 digits, present when isMenuEnabled is true)", "nullable": true, "example": "1234" }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string", "description": "Type of background environment" }, "bannerImageId": { "type": "string", "description": "UUID of banner image (required when type is 3d-model)", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "UUID of skybox image (required when type is 3d-model)", "format": "uuid" }, "threeSixtyImageId": { "type": "string", "description": "UUID of 360-degree background image (required when type is 360-background)", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "UUID of custom 3D environment (required when type is custom-3d-environment)", "format": "uuid" } }, "description": "Background settings (required when isMenuEnabled is true)", "example": { "type": "360-background", "threeSixtyImageId": "123e4567-e89b-12d3-a456-426614174000" } }, "themeId": { "type": "string", "description": "UUID of the theme to apply (required when isMenuEnabled is true)", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "sharedModeSettings": { "required": [ "enableOfflineMode", "requireManagedMetaLogin", "enableControllerFree", "adjustDeviceFit", "defaultToStationaryBoundary" ], "type": "object", "properties": { "enableOfflineMode": { "type": "boolean", "description": "Whether to enable offline mode", "example": true }, "requireManagedMetaLogin": { "type": "boolean", "description": "Whether to require managed Meta login", "example": false }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level. Use this instead of requireSessionPasscode.", "nullable": true, "example": "NONE" }, "requireSessionPasscode": { "type": "boolean", "description": "Deprecated. Use requiredPasswordComplexity instead. true maps to LOW, false maps to NONE.", "example": false, "deprecated": true }, "sessionTimeout": { "enum": [ "FIFTEEN", "THIRTY", "FORTY_FIVE", "SIXTY" ], "type": "string", "description": "Deprecated. Session timeout in minutes.", "example": "THIRTY", "deprecated": true }, "enableControllerFree": { "type": "boolean", "description": "Whether to enable controller-free mode", "example": false }, "wakeControllers": { "type": "boolean", "description": "Whether to wake controllers (required when enableControllerFree is false)", "example": true }, "adjustDeviceFit": { "type": "boolean", "description": "Whether to adjust device fit", "example": true }, "defaultToStationaryBoundary": { "type": "boolean", "description": "Whether to default to stationary boundary", "example": false } }, "description": "Shared mode settings (required for Groups and Meta HMS devices)" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/headset-experience\/default-home": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the Default Home headset experience for a group.", "operationId": "ConfigureGroupDefaultHomeHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the Default Home headset experience.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "metaHmsSettings": { "required": [ "isStoreEnabled", "isSocialEnabled", "isAddAccountsEnabled" ], "type": "object", "properties": { "isStoreEnabled": { "type": "boolean", "description": "Whether to enable the Meta store", "example": true }, "isSocialEnabled": { "type": "boolean", "description": "Whether to enable social features", "example": true }, "isAddAccountsEnabled": { "type": "boolean", "description": "Whether to enable adding new accounts", "example": true } }, "description": "Meta HMS settings (required for Groups and Meta HMS devices)", "example": { "isStoreEnabled": true, "isSocialEnabled": true, "isAddAccountsEnabled": false } } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/headset-experience\/default-home": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the Default Home headset experience for a device.", "operationId": "ConfigureDeviceDefaultHomeHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the Default Home headset experience.", "content": { "application\/json": { "schema": { "type": "object", "properties": { "metaHmsSettings": { "required": [ "isStoreEnabled", "isSocialEnabled", "isAddAccountsEnabled" ], "type": "object", "properties": { "isStoreEnabled": { "type": "boolean", "description": "Whether to enable the Meta store", "example": true }, "isSocialEnabled": { "type": "boolean", "description": "Whether to enable social features", "example": true }, "isAddAccountsEnabled": { "type": "boolean", "description": "Whether to enable adding new accounts", "example": true } }, "description": "Meta HMS settings (required for Groups and Meta HMS devices)", "example": { "isStoreEnabled": true, "isSocialEnabled": true, "isAddAccountsEnabled": false } } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/headset-experience\/in-house-launcher": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the In-House Launcher headset experience for a group.", "operationId": "ConfigureGroupInHouseLauncherHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the In-House Launcher headset experience.", "content": { "application\/json": { "schema": { "required": [ "launcherContent", "visibleContents", "returnToLauncherViaHomeButton" ], "type": "object", "properties": { "launcherContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app" ], "type": "string", "description": "Type of launcher content (must be app)" }, "id": { "type": "string", "description": "UUID of the launcher app", "format": "uuid" } }, "description": "The custom launcher app to use", "example": { "type": "app", "id": "123e4567-e89b-12d3-a456-426614174000" } }, "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the app", "format": "uuid" }, "type": { "enum": [ "app" ], "type": "string", "description": "Type of content (must be app)" } } }, "description": "Array of apps visible in the custom launcher", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174002", "type": "app" } ] }, "returnToLauncherViaHomeButton": { "type": "boolean", "description": "Whether pressing the home button returns to the custom launcher", "example": true }, "sharedModeSettings": { "required": [ "enableOfflineMode", "requireManagedMetaLogin", "enableControllerFree", "adjustDeviceFit", "defaultToStationaryBoundary" ], "type": "object", "properties": { "enableOfflineMode": { "type": "boolean", "description": "Whether to enable offline mode", "example": true }, "requireManagedMetaLogin": { "type": "boolean", "description": "Whether to require managed Meta login", "example": false }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level. Use this instead of requireSessionPasscode.", "nullable": true, "example": "NONE" }, "requireSessionPasscode": { "type": "boolean", "description": "Deprecated. Use requiredPasswordComplexity instead. true maps to LOW, false maps to NONE.", "example": false, "deprecated": true }, "sessionTimeout": { "enum": [ "FIFTEEN", "THIRTY", "FORTY_FIVE", "SIXTY" ], "type": "string", "description": "Deprecated. Session timeout in minutes.", "example": "THIRTY", "deprecated": true }, "enableControllerFree": { "type": "boolean", "description": "Whether to enable controller-free mode", "example": false }, "wakeControllers": { "type": "boolean", "description": "Whether to wake controllers (required when enableControllerFree is false)", "example": true }, "adjustDeviceFit": { "type": "boolean", "description": "Whether to adjust device fit", "example": true }, "defaultToStationaryBoundary": { "type": "boolean", "description": "Whether to default to stationary boundary", "example": false } }, "description": "Shared mode settings (required for Groups and Meta HMS devices)" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/headset-experience\/in-house-launcher": { "post": { "tags": [ "Headset Experience" ], "description": "Configure the In-House Launcher headset experience for a device.", "operationId": "ConfigureDeviceInHouseLauncherHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the In-House Launcher headset experience.", "content": { "application\/json": { "schema": { "required": [ "launcherContent", "visibleContents", "returnToLauncherViaHomeButton" ], "type": "object", "properties": { "launcherContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app" ], "type": "string", "description": "Type of launcher content (must be app)" }, "id": { "type": "string", "description": "UUID of the launcher app", "format": "uuid" } }, "description": "The custom launcher app to use", "example": { "type": "app", "id": "123e4567-e89b-12d3-a456-426614174000" } }, "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the app", "format": "uuid" }, "type": { "enum": [ "app" ], "type": "string", "description": "Type of content (must be app)" } } }, "description": "Array of apps visible in the custom launcher", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174002", "type": "app" } ] }, "returnToLauncherViaHomeButton": { "type": "boolean", "description": "Whether pressing the home button returns to the custom launcher", "example": true }, "sharedModeSettings": { "required": [ "enableOfflineMode", "requireManagedMetaLogin", "enableControllerFree", "adjustDeviceFit", "defaultToStationaryBoundary" ], "type": "object", "properties": { "enableOfflineMode": { "type": "boolean", "description": "Whether to enable offline mode", "example": true }, "requireManagedMetaLogin": { "type": "boolean", "description": "Whether to require managed Meta login", "example": false }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level. Use this instead of requireSessionPasscode.", "nullable": true, "example": "NONE" }, "requireSessionPasscode": { "type": "boolean", "description": "Deprecated. Use requiredPasswordComplexity instead. true maps to LOW, false maps to NONE.", "example": false, "deprecated": true }, "sessionTimeout": { "enum": [ "FIFTEEN", "THIRTY", "FORTY_FIVE", "SIXTY" ], "type": "string", "description": "Deprecated. Session timeout in minutes.", "example": "THIRTY", "deprecated": true }, "enableControllerFree": { "type": "boolean", "description": "Whether to enable controller-free mode", "example": false }, "wakeControllers": { "type": "boolean", "description": "Whether to wake controllers (required when enableControllerFree is false)", "example": true }, "adjustDeviceFit": { "type": "boolean", "description": "Whether to adjust device fit", "example": true }, "defaultToStationaryBoundary": { "type": "boolean", "description": "Whether to default to stationary boundary", "example": false } }, "description": "Shared mode settings (required for Groups and Meta HMS devices)" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/headset-experience": { "get": { "tags": [ "Headset Experience" ], "description": "Retrieve the headset experience configuration for a group.", "operationId": "GetGroupHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "oneOf": [ { "required": [ "id", "mode", "visibleContents", "shortcuts", "categorizationTags", "removePoweredByArborXrBranding", "sharedModeSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "arborxr-home" ], "type": "string" }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment", "interaction-method" ], "type": "string" } }, "adminPin": { "type": "string", "nullable": true }, "categorizationTags": { "type": "array", "items": { "type": "string" } }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string" }, "threeSixtyImageId": { "type": "string", "description": "Present when type is 360-background", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "bannerImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "Present when type is custom-3d-environment", "format": "uuid" } }, "nullable": true }, "themeId": { "type": "string", "format": "uuid", "nullable": true }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "nullable": true }, "menuTitle": { "type": "string", "nullable": true }, "menuIconImageId": { "type": "string", "format": "uuid", "nullable": true }, "removePoweredByArborXrBranding": { "type": "boolean" }, "sharedModeSettings": { "type": "object", "properties": { "enableOfflineMode": { "type": "boolean" }, "requireManagedMetaLogin": { "type": "boolean" }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level.", "nullable": true }, "enableControllerFree": { "type": "boolean" }, "wakeControllers": { "type": "boolean" }, "adjustDeviceFit": { "type": "boolean" }, "defaultToStationaryBoundary": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "isMenuEnabled", "sharedModeSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "arborxr-kiosk" ], "type": "string" }, "kioskContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } }, "nullable": true }, "isMenuEnabled": { "type": "boolean" }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment", "interaction-method" ], "type": "string" }, "description": "Present when isMenuEnabled is true" }, "adminPin": { "type": "string", "description": "Present when isMenuEnabled is true", "nullable": true }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string" }, "threeSixtyImageId": { "type": "string", "description": "Present when type is 360-background", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "bannerImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "Present when type is custom-3d-environment", "format": "uuid" } }, "description": "Present when isMenuEnabled is true", "nullable": true }, "themeId": { "type": "string", "description": "Present when isMenuEnabled is true", "format": "uuid", "nullable": true }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "description": "Present when isMenuEnabled is true", "nullable": true }, "menuIconImageId": { "type": "string", "description": "Present when isMenuEnabled is true", "format": "uuid", "nullable": true }, "removePoweredByArborXrBranding": { "type": "boolean", "description": "Present when isMenuEnabled is true" }, "sharedModeSettings": { "type": "object", "properties": { "enableOfflineMode": { "type": "boolean" }, "requireManagedMetaLogin": { "type": "boolean" }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level.", "nullable": true }, "enableControllerFree": { "type": "boolean" }, "wakeControllers": { "type": "boolean" }, "adjustDeviceFit": { "type": "boolean" }, "defaultToStationaryBoundary": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "metaHmsSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "device-default" ], "type": "string" }, "metaHmsSettings": { "required": [ "isStoreEnabled", "isSocialEnabled", "isAddAccountsEnabled" ], "type": "object", "properties": { "isStoreEnabled": { "type": "boolean" }, "isSocialEnabled": { "type": "boolean" }, "isAddAccountsEnabled": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "visibleContents", "returnToLauncherViaHomeButton", "sharedModeSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "custom-launcher" ], "type": "string" }, "launcherContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } }, "nullable": true }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "returnToLauncherViaHomeButton": { "type": "boolean" }, "sharedModeSettings": { "type": "object", "properties": { "enableOfflineMode": { "type": "boolean" }, "requireManagedMetaLogin": { "type": "boolean" }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level.", "nullable": true }, "enableControllerFree": { "type": "boolean" }, "wakeControllers": { "type": "boolean" }, "adjustDeviceFit": { "type": "boolean" }, "defaultToStationaryBoundary": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } ], "discriminator": { "propertyName": "mode", "mapping": { "arborxr-home": ".\/HeadsetExperienceConfiguration\/ArborXrHome.json", "arborxr-kiosk": ".\/HeadsetExperienceConfiguration\/ArborXrKiosk.json", "device-default": ".\/HeadsetExperienceConfiguration\/DeviceDefault.json", "custom-launcher": ".\/HeadsetExperienceConfiguration\/CustomLauncher.json" } } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/headset-experience": { "get": { "tags": [ "Headset Experience" ], "description": "Retrieve the headset experience configuration for a device. Returns 409 if the device belongs to a group.", "operationId": "GetDeviceHeadsetExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "oneOf": [ { "required": [ "id", "mode", "visibleContents", "shortcuts", "categorizationTags", "removePoweredByArborXrBranding", "sharedModeSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "arborxr-home" ], "type": "string" }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment", "interaction-method" ], "type": "string" } }, "adminPin": { "type": "string", "nullable": true }, "categorizationTags": { "type": "array", "items": { "type": "string" } }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string" }, "threeSixtyImageId": { "type": "string", "description": "Present when type is 360-background", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "bannerImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "Present when type is custom-3d-environment", "format": "uuid" } }, "nullable": true }, "themeId": { "type": "string", "format": "uuid", "nullable": true }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "nullable": true }, "menuTitle": { "type": "string", "nullable": true }, "menuIconImageId": { "type": "string", "format": "uuid", "nullable": true }, "removePoweredByArborXrBranding": { "type": "boolean" }, "sharedModeSettings": { "type": "object", "properties": { "enableOfflineMode": { "type": "boolean" }, "requireManagedMetaLogin": { "type": "boolean" }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level.", "nullable": true }, "enableControllerFree": { "type": "boolean" }, "wakeControllers": { "type": "boolean" }, "adjustDeviceFit": { "type": "boolean" }, "defaultToStationaryBoundary": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "isMenuEnabled", "sharedModeSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "arborxr-kiosk" ], "type": "string" }, "kioskContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } }, "nullable": true }, "isMenuEnabled": { "type": "boolean" }, "shortcuts": { "type": "array", "items": { "enum": [ "boundary", "screencast", "screen-capture", "eye-calibration", "wifi-settings", "bluetooth", "pico-controller-settings", "pico-idp-adjustment", "interaction-method" ], "type": "string" }, "description": "Present when isMenuEnabled is true" }, "adminPin": { "type": "string", "description": "Present when isMenuEnabled is true", "nullable": true }, "background": { "required": [ "type" ], "type": "object", "properties": { "type": { "enum": [ "3d-model", "360-background", "mixed-reality-mode", "custom-3d-environment" ], "type": "string" }, "threeSixtyImageId": { "type": "string", "description": "Present when type is 360-background", "format": "uuid" }, "skyboxImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "bannerImageId": { "type": "string", "description": "Present when type is 3d-model", "format": "uuid" }, "custom3DEnvironmentId": { "type": "string", "description": "Present when type is custom-3d-environment", "format": "uuid" } }, "description": "Present when isMenuEnabled is true", "nullable": true }, "themeId": { "type": "string", "description": "Present when isMenuEnabled is true", "format": "uuid", "nullable": true }, "language": { "enum": [ "zh-TW", "en", "nl", "fr", "de", "hi", "it", "ja", "ko", "pt", "es", "ro" ], "type": "string", "description": "Present when isMenuEnabled is true", "nullable": true }, "menuIconImageId": { "type": "string", "description": "Present when isMenuEnabled is true", "format": "uuid", "nullable": true }, "removePoweredByArborXrBranding": { "type": "boolean", "description": "Present when isMenuEnabled is true" }, "sharedModeSettings": { "type": "object", "properties": { "enableOfflineMode": { "type": "boolean" }, "requireManagedMetaLogin": { "type": "boolean" }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level.", "nullable": true }, "enableControllerFree": { "type": "boolean" }, "wakeControllers": { "type": "boolean" }, "adjustDeviceFit": { "type": "boolean" }, "defaultToStationaryBoundary": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "metaHmsSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "device-default" ], "type": "string" }, "metaHmsSettings": { "required": [ "isStoreEnabled", "isSocialEnabled", "isAddAccountsEnabled" ], "type": "object", "properties": { "isStoreEnabled": { "type": "boolean" }, "isSocialEnabled": { "type": "boolean" }, "isAddAccountsEnabled": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "visibleContents", "returnToLauncherViaHomeButton", "sharedModeSettings", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "custom-launcher" ], "type": "string" }, "launcherContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } }, "nullable": true }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app", "video", "web-xr-link" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "returnToLauncherViaHomeButton": { "type": "boolean" }, "sharedModeSettings": { "type": "object", "properties": { "enableOfflineMode": { "type": "boolean" }, "requireManagedMetaLogin": { "type": "boolean" }, "requiredPasswordComplexity": { "enum": [ "NONE", "LOW", "MEDIUM", "HIGH" ], "type": "string", "description": "Required password complexity level.", "nullable": true }, "enableControllerFree": { "type": "boolean" }, "wakeControllers": { "type": "boolean" }, "adjustDeviceFit": { "type": "boolean" }, "defaultToStationaryBoundary": { "type": "boolean" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } ], "discriminator": { "propertyName": "mode", "mapping": { "arborxr-home": ".\/HeadsetExperienceConfiguration\/ArborXrHome.json", "arborxr-kiosk": ".\/HeadsetExperienceConfiguration\/ArborXrKiosk.json", "device-default": ".\/HeadsetExperienceConfiguration\/DeviceDefault.json", "custom-launcher": ".\/HeadsetExperienceConfiguration\/CustomLauncher.json" } } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/device-experience\/lock-task": { "post": { "tags": [ "Device Experience" ], "description": "Configure the Lock Task device experience for a group.", "operationId": "ConfigureGroupLockTaskDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the Lock Task device experience.", "content": { "application\/json": { "schema": { "required": [ "visibleContents" ], "type": "object", "properties": { "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the app", "format": "uuid" }, "type": { "enum": [ "app", "unmanaged-app" ], "type": "string", "description": "Type of content (must be app or unmanaged-app)" } } }, "description": "Array of apps visible in the lock task experience", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "unmanaged-app" } ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/device-experience\/lock-task": { "post": { "tags": [ "Device Experience" ], "description": "Configure the Lock Task device experience for a device. Returns 409 if the device belongs to a group.", "operationId": "ConfigureDeviceLockTaskDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the Lock Task device experience.", "content": { "application\/json": { "schema": { "required": [ "visibleContents" ], "type": "object", "properties": { "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the app", "format": "uuid" }, "type": { "enum": [ "app", "unmanaged-app" ], "type": "string", "description": "Type of content (must be app or unmanaged-app)" } } }, "description": "Array of apps visible in the lock task experience", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "unmanaged-app" } ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/device-experience\/default-home": { "post": { "tags": [ "Device Experience" ], "description": "Configure the Default Home device experience for a group.", "operationId": "ConfigureGroupDefaultHomeDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the Default Home device experience.", "content": { "application\/json": { "schema": { "type": "object", "properties": {}, "example": [] } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/device-experience\/default-home": { "post": { "tags": [ "Device Experience" ], "description": "Configure the Default Home device experience for a device. Returns 409 if the device belongs to a group.", "operationId": "ConfigureDeviceDefaultHomeDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the Default Home device experience.", "content": { "application\/json": { "schema": { "type": "object", "properties": {}, "example": [] } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/device-experience\/in-house-launcher": { "post": { "tags": [ "Device Experience" ], "description": "Configure the In-House Launcher device experience for a group.", "operationId": "ConfigureGroupInHouseLauncherDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the In-House Launcher device experience.", "content": { "application\/json": { "schema": { "required": [ "launcherContent", "visibleContents" ], "type": "object", "properties": { "launcherContent": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the launcher app", "format": "uuid" }, "type": { "enum": [ "app" ], "type": "string", "description": "Type of launcher content (must be app)" } }, "description": "The app that will serve as the in-house launcher", "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "type": "app" } }, "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the app", "format": "uuid" }, "type": { "enum": [ "app", "unmanaged-app" ], "type": "string", "description": "Type of content (must be app or unmanaged-app)" } } }, "description": "Array of apps visible within the in-house launcher", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174002", "type": "unmanaged-app" } ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/device-experience\/in-house-launcher": { "post": { "tags": [ "Device Experience" ], "description": "Configure the In-House Launcher device experience for a device. Returns 409 if the device belongs to a group.", "operationId": "ConfigureDeviceInHouseLauncherDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Request body for configuring the In-House Launcher device experience.", "content": { "application\/json": { "schema": { "required": [ "launcherContent", "visibleContents" ], "type": "object", "properties": { "launcherContent": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the launcher app", "format": "uuid" }, "type": { "enum": [ "app" ], "type": "string", "description": "Type of launcher content (must be app)" } }, "description": "The app that will serve as the in-house launcher", "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "type": "app" } }, "visibleContents": { "type": "array", "items": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the app", "format": "uuid" }, "type": { "enum": [ "app", "unmanaged-app" ], "type": "string", "description": "Type of content (must be app or unmanaged-app)" } } }, "description": "Array of apps visible within the in-house launcher", "example": [ { "id": "123e4567-e89b-12d3-a456-426614174001", "type": "app" }, { "id": "123e4567-e89b-12d3-a456-426614174002", "type": "unmanaged-app" } ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/device-experience": { "get": { "tags": [ "Device Experience" ], "description": "Retrieve the device experience configuration for a group.", "operationId": "GetGroupDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "oneOf": [ { "required": [ "id", "mode", "visibleContents", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "lock-task" ], "type": "string" }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "launcherContent", "visibleContents", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "custom-launcher" ], "type": "string" }, "launcherContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } }, "nullable": true }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "device-default" ], "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" } } } ], "discriminator": { "propertyName": "mode", "mapping": { "lock-task": ".\/DeviceExperienceConfiguration\/LockTask.json", "custom-launcher": ".\/DeviceExperienceConfiguration\/CustomLauncher.json", "device-default": ".\/DeviceExperienceConfiguration\/DeviceDefault.json" } } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/devices\/{deviceId}\/device-experience": { "get": { "tags": [ "Device Experience" ], "description": "Retrieve the device experience configuration for a device. Returns 409 if the device belongs to a group.", "operationId": "GetDeviceDeviceExperience", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "deviceId", "in": "path", "description": "The ID of a device.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "oneOf": [ { "required": [ "id", "mode", "visibleContents", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "lock-task" ], "type": "string" }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "launcherContent", "visibleContents", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "custom-launcher" ], "type": "string" }, "launcherContent": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } }, "nullable": true }, "visibleContents": { "type": "array", "items": { "required": [ "type", "id" ], "type": "object", "properties": { "type": { "enum": [ "app", "unmanaged-app" ], "type": "string" }, "id": { "type": "string", "format": "uuid" } } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, { "required": [ "id", "mode", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174000" }, "mode": { "enum": [ "device-default" ], "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2023-10-15T14:30:00.000Z" } } } ], "discriminator": { "propertyName": "mode", "mapping": { "lock-task": ".\/DeviceExperienceConfiguration\/LockTask.json", "custom-launcher": ".\/DeviceExperienceConfiguration\/CustomLauncher.json", "device-default": ".\/DeviceExperienceConfiguration\/DeviceDefault.json" } } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "409": { "description": "Conflict", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "groupId": { "type": "string", "format": "uuid" } }, "example": { "message": "This device belongs to a group. Query the group's headset experience configuration instead.", "groupId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/custom-3d-environments": { "get": { "tags": [ "Custom 3D Environments" ], "description": "Get a paginated list of custom 3D environments in your organization.", "operationId": "GetCustom3DEnvironments", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "objectName", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "objectName": { "type": "string", "description": "The filename of the 3D environment file (must be .glb format)", "example": "my-environment.glb" }, "sizeBytes": { "type": "integer", "description": "The size of the 3D environment file in bytes", "nullable": true, "example": 10240000 }, "status": { "enum": [ "available", "pending" ], "type": "string", "description": "The current status of the 3D environment", "example": "available" }, "downloadUrl": { "type": "string", "description": "Download URL for the 3D environment (only present when status is available)", "format": "uri", "nullable": true, "example": "https:\/\/storage.example.com\/custom-3d-environments\/my-environment.glb?signature=abc123" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true }, "label": { "type": "string" }, "active": { "type": "boolean" } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of custom 3D environments.", "example": { "data": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "objectName": "my-environment.glb", "sizeBytes": 10240000, "status": "available", "downloadUrl": "https:\/\/storage.example.com\/custom-3d-environments\/my-environment.glb?signature=abc123", "createdAt": "2023-10-15T14:30:00.000Z", "updatedAt": "2023-10-15T14:30:00.000Z" } ], "links": { "first": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=1", "last": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=3", "prev": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=1", "next": "https:\/\/api.xrdm.app\/api\/v3\/custom-3d-environments?per_page=10&page=3" }, "meta": { "current_page": 2, "from": 11, "last_page": 3, "per_page": 10, "to": 20, "total": 25 } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Custom 3D Environments" ], "description": "Initiate a custom 3D environment upload. Returns upload credentials for multipart upload.", "operationId": "InitiateCustom3DEnvironmentUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "Initiate a new custom 3D environment upload.", "content": { "application\/json": { "schema": { "required": [ "filename" ], "type": "object", "properties": { "filename": { "type": "string", "description": "The filename for the 3D environment (must have .glb extension)", "example": "my-environment.glb" } } }, "example": { "filename": "my-environment.glb" } } } }, "responses": { "201": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "uploadId": { "type": "string", "example": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ" }, "key": { "type": "string", "example": "custom-3d-environments%2F123e4567-e89b-12d3-a456-426614174000%2Fmy-environment.glb" }, "custom3DEnvironmentId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "example": { "uploadId": "OGRhZDQ5NTMtOTQxYS00ZDI3LWE0MzUtOGUyNzEzZWZiYTlmLmY1YmE5NTkyLWIzZDMtNDE1ZS1iOWIxLWM1YWJjYjAxMmY5OQ", "key": "custom-3d-environments%2F123e4567-e89b-12d3-a456-426614174000%2Fmy-environment.glb", "custom3DEnvironmentId": "123e4567-e89b-12d3-a456-426614174000" } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/custom-3d-environments\/{custom3DEnvironmentId}": { "get": { "tags": [ "Custom 3D Environments" ], "description": "Get a custom 3D environment by ID.", "operationId": "GetCustom3DEnvironment", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "custom3DEnvironmentId", "in": "path", "description": "The ID of the custom 3D environment.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "required": [ "id", "objectName", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "objectName": { "type": "string", "description": "The filename of the 3D environment file (must be .glb format)", "example": "my-environment.glb" }, "sizeBytes": { "type": "integer", "description": "The size of the 3D environment file in bytes", "nullable": true, "example": 10240000 }, "status": { "enum": [ "available", "pending" ], "type": "string", "description": "The current status of the 3D environment", "example": "available" }, "downloadUrl": { "type": "string", "description": "Download URL for the 3D environment (only present when status is available)", "format": "uri", "nullable": true, "example": "https:\/\/storage.example.com\/custom-3d-environments\/my-environment.glb?signature=abc123" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/custom-3d-environments\/{custom3DEnvironmentId}\/pre-sign": { "post": { "tags": [ "Custom 3D Environments" ], "description": "Pre-sign URLs for multipart upload parts.", "operationId": "PreSignCustom3DEnvironmentUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "custom3DEnvironmentId", "in": "path", "description": "The ID of the custom 3D environment.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Pre-sign URLs for multipart upload parts.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "partNumbers" ], "type": "object", "properties": { "key": { "type": "string", "description": "The key returned from the initiate upload request", "example": "custom-3d-environments%2F123e4567-e89b-12d3-a456-426614174000%2Fmy-environment.glb" }, "uploadId": { "type": "string", "description": "The upload ID returned from the initiate upload request", "example": "ExampleUploadId123" }, "partNumbers": { "maxItems": 4, "minItems": 1, "type": "array", "items": { "minimum": 1, "type": "integer" }, "description": "Array of part numbers to pre-sign", "example": [ 1, 2, 3 ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "partNumber": { "minimum": 1, "type": "integer" }, "presignedUrl": { "type": "string", "description": "Pre-signed URL for uploading this part", "format": "uri" } } }, "example": [ { "partNumber": 1, "presignedUrl": "https:\/\/s3.amazonaws.com\/bucket\/key?partNumber=1&uploadId=abc123&X-Amz-Algorithm=AWS4-HMAC-SHA256..." }, { "partNumber": 2, "presignedUrl": "https:\/\/s3.amazonaws.com\/bucket\/key?partNumber=2&uploadId=abc123&X-Amz-Algorithm=AWS4-HMAC-SHA256..." } ] } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/custom-3d-environments\/{custom3DEnvironmentId}\/complete": { "post": { "tags": [ "Custom 3D Environments" ], "description": "Complete a multipart upload for a custom 3D environment.", "operationId": "CompleteCustom3DEnvironmentUpload", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "custom3DEnvironmentId", "in": "path", "description": "The ID of the custom 3D environment.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "Complete a multipart upload for a custom 3D environment.", "content": { "application\/json": { "schema": { "required": [ "key", "uploadId", "parts" ], "type": "object", "properties": { "key": { "type": "string", "description": "The key returned from the initiate upload request", "example": "custom-3d-environments%2F123e4567-e89b-12d3-a456-426614174000%2Fmy-environment.glb" }, "uploadId": { "type": "string", "description": "The upload ID returned from the initiate upload request", "example": "ExampleUploadId123" }, "parts": { "type": "array", "items": { "required": [ "partNumber", "eTag" ], "type": "object", "properties": { "partNumber": { "minimum": 1, "type": "integer" }, "eTag": { "type": "string", "description": "ETag returned from S3 after uploading the part" } } }, "description": "Array of completed parts with their ETags", "example": [ { "partNumber": 1, "eTag": "\"d41d8cd98f00b204e9800998ecf8427e\"" } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "required": [ "id", "objectName", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "objectName": { "type": "string", "description": "The filename of the 3D environment file (must be .glb format)", "example": "my-environment.glb" }, "sizeBytes": { "type": "integer", "description": "The size of the 3D environment file in bytes", "nullable": true, "example": 10240000 }, "status": { "enum": [ "available", "pending" ], "type": "string", "description": "The current status of the 3D environment", "example": "available" }, "downloadUrl": { "type": "string", "description": "Download URL for the 3D environment (only present when status is available)", "format": "uri", "nullable": true, "example": "https:\/\/storage.example.com\/custom-3d-environments\/my-environment.glb?signature=abc123" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/group-hierarchy": { "get": { "tags": [ "Groups" ], "description": "Get the complete hierarchy tree of all groups in your organization.", "operationId": "GetGroupHierarchy", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "isConfigured": { "type": "boolean", "example": true }, "deviceCount": { "type": "integer", "description": "Only present for configured groups", "example": 25 }, "children": { "type": "array", "items": { "$ref": "#\/paths\/~1group-hierarchy\/get\/responses\/200\/content\/application~1json\/schema\/properties\/data\/items" }, "description": "Only present for unconfigured groups" }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Canada", "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z", "children": [ { "id": "223e4567-e89b-12d3-a456-426614174000", "name": "Ontario", "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z", "children": [ { "id": "323e4567-e89b-12d3-a456-426614174000", "name": "Toronto", "isConfigured": true, "deviceCount": 15, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, { "id": "423e4567-e89b-12d3-a456-426614174000", "name": "Ottawa", "isConfigured": true, "deviceCount": 8, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } ] } ] } } } }, "description": "The complete hierarchy tree of all groups." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups": { "get": { "tags": [ "Groups" ], "description": "Get a paginated list of groups in your organization (both configured and unconfigured). Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetGroups", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/groups?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/groups?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/groups?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/groups?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/groups?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/groups" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of groups." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Groups" ], "description": "Create a new group.", "operationId": "CreateGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } } ], "requestBody": { "description": "The group fields to create a new group.", "content": { "application\/json": { "schema": { "required": [ "name", "parentId" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group", "example": "New Warehouse Group" }, "parentId": { "type": "string", "description": "The ID of the parent group (for nested groups). Must be an unconfigured group. Pass null for a root-level group.", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174001" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}": { "get": { "tags": [ "Groups" ], "description": "Get a single group.", "operationId": "GetGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "put": { "tags": [ "Groups" ], "description": "Update a group.", "operationId": "UpdateGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The group fields to update an existing group.", "content": { "application\/json": { "schema": { "required": [ "name", "parentId" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name of the group", "example": "Updated Warehouse Group" }, "parentId": { "type": "string", "description": "The ID of the parent group (for nested groups). Must be an unconfigured group. Pass null to make this a root-level group.", "format": "uuid", "nullable": true, "example": "123e4567-e89b-12d3-a456-426614174001" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "delete": { "tags": [ "Groups" ], "description": "Delete a group. For unconfigured groups, you can optionally specify a replacement group to move child groups to.", "operationId": "DeleteGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "replacementGroupId", "in": "query", "description": "ID of replacement group to move child groups to (only allowed for unconfigured groups)", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/configure": { "patch": { "tags": [ "Groups" ], "description": "Configure a group. Once configured, devices can be assigned to the group and configurations can be applied. This action cannot be undone.", "operationId": "ConfigureGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/duplicate": { "post": { "tags": [ "Groups" ], "description": "Duplicate a configured group. Creates a new configured group with all the same configurations as the original. The new group will have no devices assigned.", "operationId": "DuplicateGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The name for the duplicated group.", "content": { "application\/json": { "schema": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "The name for the new duplicated group", "example": "Duplicated Warehouse Group" } } } } } }, "responses": { "201": { "description": "Success", "content": { "application\/json": { "schema": { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Midwest Warehouse" }, "deviceCount": { "type": "integer", "description": "Number of devices in this group. Only present for configured groups.", "nullable": true, "example": 25 }, "isConfigured": { "type": "boolean", "example": true }, "parent": { "anyOf": [ { "type": "null" }, { "required": [ "id", "name", "isConfigured", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "deviceCount": { "type": "integer", "nullable": true }, "isConfigured": { "type": "boolean" }, "parent": { "anyOf": [ { "type": "null" }, { "type": "object" } ], "description": "Recursive parent structure" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } ], "description": "The parent group, if any. Can be nested arbitrarily deep." }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } }, "example": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Midwest Warehouse", "deviceCount": 25, "isConfigured": true, "parent": { "id": "123e4567-e89b-12d3-a456-426614174001", "name": "North America", "deviceCount": 100, "isConfigured": false, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" }, "createdAt": "2024-01-01T12:00:00.000Z", "updatedAt": "2024-01-02T12:00:00.000Z" } } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/release-channels": { "get": { "tags": [ "Groups" ], "description": "Get a paginated list of release channels for a configured group. Results are ordered by `created_at` (descending) and `id` (ascending) to ensure stable pagination.", "operationId": "GetGroupReleaseChannels", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Stable" }, "app": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My App" }, "description": { "type": "string", "nullable": true, "example": "This is my app." }, "tags": { "type": "array", "items": { "type": "string", "example": "tag1" }, "example": [ "tag1", "tag2" ] }, "deviceModels": { "type": "array", "items": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Meta Quest 2" }, "manufacturer": { "type": "string", "example": "Meta" }, "isSupported": { "type": "boolean", "example": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-15T13:45:30.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-06-20T10:20:30.000Z" } } } }, "packageName": { "type": "string", "nullable": true, "example": "com.example.myapp" }, "installedDeviceCount": { "type": "integer", "example": 42 }, "icon": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "status": { "enum": [ "available", "pending" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "description": "URL to download the icon. Returns null when status is not 'available'.", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.png" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-05T14:48:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-06T10:20:30.000Z" } }, "nullable": true }, "latestAvailableVersion": { "type": "string", "nullable": true, "example": "1.0.0" }, "ownerOrganization": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "My Organization™" }, "slug": { "type": "string", "example": "my-organization-tm" }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-10-15T14:30:00.000Z" } } }, "createdAt": { "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2023-01-02T12:00:00.000Z" } } }, "version": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "bundle": { "properties": { "id": { "type": "string", "description": "Unique identifier for the app bundle", "format": "uuid", "example": "789e1234-e89b-12d3-a456-426614174000" }, "label": { "type": "string", "description": "Auto-generated label of the app bundle. First bundle has no label, subsequent bundles get 'Original' and 'Copy N' labels.", "nullable": true, "example": "Original" }, "status": { "enum": [ "pending", "processing", "failed", "available" ], "type": "string", "description": "Current status of the app bundle", "example": "pending" }, "appBuild": { "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "version": { "type": "string", "nullable": true, "example": "2.0.0-prealpha+328" }, "code": { "type": "integer", "nullable": true, "example": 328 }, "sizeBytes": { "type": "integer", "nullable": true, "example": 104857600 }, "checksum": { "properties": { "algorithm": { "enum": [ "MD5", "SHA-256", "SHA-512" ], "type": "string", "example": "SHA-256" }, "value": { "type": "string", "example": "3a7bd3e2360a3d29eea4a5c13c6b1b9b1f5f5c1f9e6e6e6e6e6e6e6e6e6e6e6" } } }, "status": { "enum": [ "pending", "uploaded", "downloading-content", "parsing-content", "verifying-package-name", "verifying-version-code", "verifying-insights-sdk", "verifying-signature", "parsing-content-icon", "finalizing-build-processing", "available", "error" ], "type": "string", "example": "available" }, "downloadUrl": { "type": "string", "nullable": true, "example": "https:\/\/storage.bucket.arborxr.com\/path\/to\/file.apk" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "createdAt": { "type": "string", "description": "Timestamp when the bundle was created", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" }, "updatedAt": { "type": "string", "description": "Timestamp when the bundle was last updated", "format": "date-time", "example": "2025-08-25T18:10:23.000Z" } } }, "deviceStatuses": { "type": "array", "items": { "type": "object", "properties": { "deviceId": { "type": "string", "format": "uuid", "nullable": false, "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "nullable": false, "example": "succeeded-install" }, "targetVersion": { "type": "string", "example": "1.2.3" }, "installedVersion": { "type": "string", "nullable": true, "example": "1.1.1" }, "statusTimestamp": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.123Z" } }, "nullable": false }, "description": "Deprecated. Use the GET \/apps\/{appId}\/release-channels\/{releaseChannelId}\/device-statuses endpoint instead.", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T12:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2024-01-02T12:00:00.000Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/groups\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/groups\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/groups\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/groups\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/groups\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/groups\/c8bb3467-04da-42d1-8ced-86c9b667e21c\/release-channels" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "A paginated list of release channels for a group." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Groups" ], "description": "Add a release channel to a configured group.", "operationId": "AddReleaseChannelToGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The release channel to add to the group.", "content": { "application\/json": { "schema": { "required": [ "releaseChannelId" ], "type": "object", "properties": { "releaseChannelId": { "type": "string", "description": "The ID of the release channel to add to the group", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/release-channels\/{releaseChannelId}": { "delete": { "tags": [ "Groups" ], "description": "Remove a release channel from a configured group.", "operationId": "RemoveReleaseChannelFromGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "releaseChannelId", "in": "path", "description": "The ID of a release channel.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/files": { "post": { "tags": [ "Groups" ], "description": "Add a file to a configured group.", "operationId": "AddFileToGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The file to add to the group.", "content": { "application\/json": { "schema": { "required": [ "fileId" ], "type": "object", "properties": { "fileId": { "type": "string", "description": "The ID of the file to add to the group", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/files\/{fileId}": { "delete": { "tags": [ "Groups" ], "description": "Remove a file from a configured group.", "operationId": "RemoveFileFromGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/videos": { "post": { "tags": [ "Groups" ], "description": "Add a video to a configured group.", "operationId": "AddVideoToGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The video to add to the group.", "content": { "application\/json": { "schema": { "required": [ "videoId" ], "type": "object", "properties": { "videoId": { "type": "string", "description": "The ID of the video to add to the group", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/videos\/{videoId}": { "delete": { "tags": [ "Groups" ], "description": "Remove a video from a configured group.", "operationId": "RemoveVideoFromGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/tags\/attach": { "patch": { "tags": [ "Groups" ], "description": "Attach tags to a group.", "operationId": "AttachTagsToGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/groups\/{groupId}\/tags\/detach": { "patch": { "tags": [ "Groups" ], "description": "Detach tags from a group.", "operationId": "DetachTagsFromGroup", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "groupId", "in": "path", "description": "The ID of a group.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } } ], "requestBody": { "description": "The tags to attach or detach.", "content": { "application\/json": { "schema": { "required": [ "tags" ], "type": "object", "properties": { "tags": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string" }, "example": [ "stable", "pre-release", "beta" ] } } } } } }, "responses": { "204": { "description": "Success - No Content" }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/files\/{fileId}\/device-statuses": { "get": { "tags": [ "Files" ], "description": "Get a paginated list of device statuses for a file.", "operationId": "GetFileDeviceStatuses", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "fileId", "in": "path", "description": "The ID of a file.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "deviceId", "status", "statusTimestamp" ], "properties": { "deviceId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T12:00:00.123Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/files\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/files\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/files\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/files\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/files\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/files\/123e4567-e89b-12d3-a456-426614174000\/device-statuses" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of device statuses for a file." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/videos\/{videoId}\/device-statuses": { "get": { "tags": [ "Videos" ], "description": "Get a paginated list of device statuses for a video.", "operationId": "GetVideoDeviceStatuses", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "videoId", "in": "path", "description": "The ID of a video.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "deviceId", "status", "statusTimestamp" ], "properties": { "deviceId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T12:00:00.123Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/videos\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/videos\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/videos\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/videos\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/videos\/123e4567-e89b-12d3-a456-426614174000\/device-statuses?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/videos\/123e4567-e89b-12d3-a456-426614174000\/device-statuses" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of device statuses for a video." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/apps\/{appId}\/release-channels\/{releaseChannelId}\/device-statuses": { "get": { "tags": [ "Apps" ], "description": "Get a paginated list of device statuses for a release channel.", "operationId": "GetReleaseChannelDeviceStatuses", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "appId", "in": "path", "description": "The ID of an app.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "releaseChannelId", "in": "path", "description": "The ID of a release channel.", "required": true, "schema": { "type": "string", "format": "uuid", "nullable": false } }, { "name": "per_page", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "type": "integer", "default": 10, "nullable": false } }, { "name": "page", "in": "query", "description": "The page number to return.", "required": false, "schema": { "type": "integer", "default": 1, "nullable": false } } ], "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "required": [ "deviceId", "targetVersion", "installedVersion", "status", "statusTimestamp" ], "properties": { "deviceId": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174001" }, "targetVersion": { "type": "string", "nullable": true, "example": "1.2.3" }, "installedVersion": { "type": "string", "nullable": true, "example": "1.1.1" }, "status": { "enum": [ "pending-install", "pending-update", "pending-uninstall", "waiting-install", "waiting-update", "waiting-uninstall", "in-progress-install", "in-progress-update", "in-progress-uninstall", "succeeded-install", "succeeded-update", "succeeded-uninstall", "failed-install", "failed-update", "failed-uninstall", "not-compatible" ], "type": "string", "example": "succeeded-install" }, "statusTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T12:00:00.123Z" } } } }, "links": { "type": "object", "properties": { "first": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels\/123e4567-e89b-12d3-a456-426614174001\/device-statuses?per_page=10&page=1" }, "last": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels\/123e4567-e89b-12d3-a456-426614174001\/device-statuses?per_page=10&page=3" }, "prev": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels\/123e4567-e89b-12d3-a456-426614174001\/device-statuses?per_page=10&page=1" }, "next": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels\/123e4567-e89b-12d3-a456-426614174001\/device-statuses?per_page=10&page=3" } } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 2 }, "from": { "type": "integer", "nullable": true, "example": 11 }, "last_page": { "type": "integer", "example": 3 }, "links": { "type": "array", "items": { "properties": { "url": { "type": "string", "nullable": true, "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels\/123e4567-e89b-12d3-a456-426614174001\/device-statuses?per_page=10&page=1" }, "label": { "type": "string", "example": "1" }, "active": { "type": "boolean", "example": true } } } }, "path": { "type": "string", "example": "https:\/\/api.xrdm.app\/api\/v3\/apps\/123e4567-e89b-12d3-a456-426614174000\/release-channels\/123e4567-e89b-12d3-a456-426614174001\/device-statuses" }, "per_page": { "type": "integer", "example": 10 }, "to": { "type": "integer", "nullable": true, "example": 20 }, "total": { "type": "integer", "example": 25 } } } }, "description": "Get a paginated list of device statuses for a release channel." } } } }, "400": { "description": "Bad Request", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } }, "\/insights\/data\/{insightsAppId}": { "post": { "tags": [ "Insights" ], "description": "Query analytics data from the Insights platform. Returns paginated results from the specified collection, with support for filtering, grouping, and aggregation. Requires a token with the `insights-api` ability and the Insights API feature enabled for the organization.", "operationId": "QueryInsightsData", "parameters": [ { "name": "Accept", "in": "header", "required": true, "schema": { "enum": [ "application\/json" ], "type": "string", "default": "application\/json" } }, { "name": "insightsAppId", "in": "path", "description": "The Insights App ID to query data for.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "123e4567-e89b-12d3-a456-426614174000" } ], "requestBody": { "description": "Query insights analytics data", "content": { "application\/json": { "schema": { "type": "object", "properties": { "organization_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filter by organization IDs.", "example": [ "550e8400-e29b-41d4-a716-446655440000" ] }, "page": { "minimum": 1, "type": "integer", "description": "Page number for pagination.", "example": 1 }, "page_size": { "maximum": 10000, "minimum": 1, "type": "integer", "description": "Number of items per page.", "example": 100 }, "start_date": { "type": "string", "description": "Filter data from this date.", "format": "date", "example": "2026-01-01" }, "end_date": { "type": "string", "description": "Filter data until this date.", "format": "date", "example": "2026-03-01" }, "collection": { "enum": [ "basicLog", "telemetry", "event", "sessionLog" ], "type": "string", "description": "The data collection to query." }, "group_by": { "type": "array", "items": { "type": "string" }, "description": "Fields to group results by.", "example": [ "device_id", "app_name" ] }, "aggregate": { "enum": [ "count", "sum", "avg", "unique", "max", "min" ], "type": "string", "description": "Aggregation function to apply." }, "aggregate_field": { "type": "string", "description": "The field to aggregate on. Required when aggregate is specified.", "example": "value" }, "timezone": { "type": "string", "description": "Timezone for date-based operations.", "example": "America\/New_York" }, "filter_query": { "type": "object", "description": "Filter criteria for the query.", "additionalProperties": true }, "search_term": { "type": "string", "description": "Search term to filter results.", "example": "test search" }, "group_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by group IDs.", "example": [ "group-1", "group-2" ] }, "device_ids": { "type": "array", "items": { "type": "string" }, "description": "Filter by device IDs.", "example": [ "device-1", "device-2" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "Array of analytics data items. The schema of each item varies depending on the collection type and query parameters." }, "next_page": { "type": "integer", "description": "The next page number, or null if there are no more pages.", "nullable": true, "example": 2 }, "prev_page": { "type": "integer", "description": "The previous page number, or null if on the first page.", "nullable": true, "example": null } }, "description": "A paginated list of insights analytics data. The shape of items in the data array varies by collection type." } } } }, "401": { "description": "Unauthorized", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unauthorized" } } } } }, "403": { "description": "Forbidden", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Forbidden" } } } } }, "404": { "description": "Not Found", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Not Found" } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Unprocessable Entity" } } } } }, "500": { "description": "Internal Server Error", "content": { "application\/json": { "schema": { "type": "object", "example": { "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [] } ] } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "description": "Generate a token in the ArborXR Portal by navigating to: Settings > Access Tokens. For information about how to generate an access token for the API, visit this article: [Generating an Access Token](https:\/\/developers.arborxr.com\/docs\/how-to-generate-an-access-token).", "scheme": "bearer", "bearerFormat": "Bearer 4|trt1R8vFzrDF7ksKG0iG8mFYAYbQkEIWa7JtEAA4e415a57f" } } } }