Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
Android

Generate Appium connection URL

Generate a pre-signed proxy URL for Appium server of a running Android box.

post/boxes/{boxId}/android/connect-url/appium

Path parameters

boxIdstring required
Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

expiresInstring

The Appium connection url will be alive for the given duration

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 120m

Example request

{
  "expiresIn": "120m"
}

Response

Appium connection information

urlstring required

Appium connection URL

udidstring required

Device UDID for Appium connection

logLevel'trace' | 'debug' | 'info' | 'warn' | 'error' | 'silent' required

Log level for WebdriverIO/Appium client

Example response

{
  "url": "https://gbox.ai/api/share/v1/proxy/tmp_token123/appium",
  "udid": "emulator-5554",
  "defaultOption": {
    "protocol": "https",
    "hostname": "gbox.ai",
    "port": 443,
    "path": "/api/share/v1/proxy/tmp_token123/appium",
    "capabilities": {
      "platformName": "Android",
      "appium:automationName": "UiAutomator2",
      "appium:udid": "emulator-5554",
      "appium:deviceName": "emulator-5554"
    }
  },
  "logLevel": "error"
}