Skip to content

Learn Reference MCP setup ↗

Find a guide, function or endpoint

Learn

Overview Your first automation Scripts and projects JavaScript essentials Find app elements Handle interruptions Screen and vision Objective-C step by step C functions and memory Troubleshooting Connect an agent Automation playbook HTTP workflows and details

HTTP endpoints

All HTTP endpoints

Discovery

GET /GET /endpoints GET /automation

Apps and device

GET /apps/list GET /appInfo POST /apps/open POST /device/button POST /device/touch GET /device/screenshot GET /deviceInfo GET /SN GET /IP GET /tweakVersion GET /temperature

Script files

GET /files/list GET /files/read GET /files/download POST /files/write POST /files/mkdir POST /files/move POST /files/delete

Saved scripts

POST /scripts/run GET /scripts/runs POST /scripts/stop GET /isBusy GET /runningScripts GET /stopAll

JavaScript jobs

POST /automation/run GET /automation/runs POST /automation/stop POST /automation/delete

UIHelper HTTP

GET /ui GET /ui/observe POST /ui/observe POST /ui/query GET /ui/element POST /ui/action POST /ui/wait GET /ui/screenshot POST /ui/inspector

Diagnostics

GET /logs GET /logs/clear GET /lastError GET /diagnostics/crashes GET /diagnostics/crash

Settings

GET /settings POST /settings GET /settings/logs POST /settings/action GET /setDebugLog GET /setErrorAlert GET /setScriptToasts GET /setSafeMode GET /setKeepAwake

JavaScript reference

Apps

openApp waitForApp appKill appInfo getAppState appStateInfo frontMostAppId frontMostAppOrientation openURL

Touches and keyboard

tap touchDown touchMove touchUp swipe keyDown keyUp KEY_TYPE typeText deleteText hideKeyboard copyText readClipboard setTouchPressure

Timing and runtime

usleep msleep sleep stop setSpeed

Device and feedback

getScreenInfo getDeviceInfo getBatteryInfo getTemperature getVersion getSN getLocalIP kernelVersion setBrightness setKeepAwake getKeepAwake setAvoidSafeMode getAvoidSafeMode vibrate say playSound playSystemAlarm showNotice alert log clearLog

Shell and system

execResult exec execAsRoot isVpnActive enableVPN disableVPN

Files and encoding

scriptsDir jbrootForPath readFile writeFile fileExists listDir copyFile moveFile deleteFile makeDir sha256 sha256Base64 md5 base64Encode base64Decode

Screen and vision

screenshot getColor getColors rgbToInt intToRgb ocr recognizeTextSupportedLanguages searchColor findColors findImage

UIHelper queries

UIHelper.forApp UIHelper.findElement UIHelper.findElements UIHelper.waitForElement UIHelper.exists UIHelper.waitForGone UIHelper.waitForAny UIHelper.waitForAll UIHelper.waitFor UIHelper.tap UIHelper.findElementsInRect UIHelper.getTree UIHelper.observe

Element actions

Element.tap Element.setText Element.typeText Element.clear Element.scroll Element.scrollIntoView Element.getAttributes Element.getText Element.getValue Element.getRect Element.isDisplayed Element.isEnabled Element.getAttribute Element.exists Element.snapshot Element.findElement Element.findElements Element.waitForElement Element.waitForGone Element.waitForAny Element.waitForAll Element.waitFor Element.findElementsInRect Element.getTree Element.toJSON Element.id

Modules and async

require require.resolve module.exports exports __dirname __filename args require.cache require.main module.require setTimeout setInterval setImmediate clearTimeout clearInterval clearImmediate globalThis at module

HTTP requests

fetch Response.text Response.json Headers.get Headers.has Headers.entries Headers.forEach request request.get request.post request.put request.patch request.delete request.head request.defaults RequestHandle.abort httpRequest httpGet Response.properties

Objective-C

RemoteObjC.forApp ObjC.class ObjC.hasClass ObjC.call ObjC.create ObjC.getInfo ObjC.out ObjC.setTimeout ObjC.close ObjC.reconnect RemoteObjC.closeAll ObjCObject.call ObjCObject.get ObjCObject.set ObjCObject.toJS ObjCObject.respondsTo ObjCObject.signature ObjCObject.release ObjCObject.metadata classExists classHasSelector ObjC.C ObjCObject.toJSON ObjCObject.toString ObjCOut.value

Native C functions

RemoteC.forApp C.bind C.bindAddress C.call C.alloc C.getInfo C.setTimeout C.close C.reconnect RemoteC.closeAll CFunction.invoke CFunction.release CPointer.byteLength CPointer.readBytes CPointer.writeBytes CPointer.release

Read Markdown ↗Download .md

Theme

isVpnActive

Check whether a VPN appears active.

js

isVpnActive()

Arguments

No arguments.

Returns

Boolean.

Example

js

console.log(isVpnActive());

All JavaScript APIs · Automation playbook

ApplesauceOS documentation · JavaScript on your device.
Read the expected result. Test the actual result. Troubleshooting · Markdown index