Skip to content

REST API (PLUS) ​

If you have Remote Admin enabled you can use its features as a simple REST API interface in order to control the device from your local network. The base URL address is always http://ip-address:2323. You can use HTTPS for this connection, as described in the Remote Admin section.

You have to specify the Remote Admin Password on the query string like password=08154711. Add type=json to the query string in order to get a short JSON response. Don’t forget to URLencode all query string parameters.

Sample API calls:

GET http://192.168.178.1/getDeviceInfo?type=json&password=08154711
  
GET http://192.168.178.1/loadUrl?url=https%3A%2F%2Fwww.google.com&type=json&password=08154711

Full list of REST API endpoints with extra parameters:

Get Device Info and Logs
// Get Device Info JSON
/getDeviceInfo  
  
// Get Fully Log  
/showLog  
  
// Get Logcat  
/logcat
Web Browsing
// Load URL
/loadStartUrl
/loadUrl?url=[url]
/loadUrl?url=[url]&tab=[0..n]&focus=[true|false]
/loadUrl?url=[url]&newtab=[true|false]&focus=[true|false]/injectJavascript?code=code (ver. 1.60+)

// Manage Tabs
/focusTab?tab=[index]
/closeTab?tab=[index]
/refreshTab

// Remove Web Items
/clearCache
/clearWebstorage
/clearCookies
/resetWebview
Screen on/off, Screensaver and Daydream
// Screen on/off
/screenOn
/screenOff
/forceSleep

// Simulate Motion
/triggerMotion

// Fully Screensaver and Android Screen Saver (Daydream)
/startScreensaver
/stopScreensaver
/startDaydream (Android 10 and older!)
/stopDaydream (Android 10 and older!)
Kiosk and App Management
// Unlock/lock kiosk mode
/lockKiosk
/unlockKiosk

// Start other apps
/startApplication?package=[pkg]
/startIntent?url=[intenturl]
  
// Bring Fully app to foreground/background  
/toForeground
/toBackground

// Restart and exit Fully Kiosk
/restartApp
/exitApp
/killMyProcess  // Kill my app hard (ver. 1.55+) 

// Return to main view if any special view (PDF, Settings, Menu) is open
/popFragment

// Download and launch APK file, user input can be required for install
// If app already installed in this version, APK install will be started only if forceInstall=true
// These features are not available if you installed Fully Kiosk from Google Play
/loadApkFile?url=[url]&forceInstall=[true|false]
/uninstallApp?package=[package]

// Get current APK installation status (JSON)
/getInstallApkState

// Kill background processes for package (Android 13 and older)
/killBackgroundProcesses?package=[package]

// Clear app data (Android 9+, provisioned devices only)
/clearAppData?package=[package]
  
// Install Certificate in User Certificate Store (provisioned devices only)  
/installUserCa?url=[url]
// Lock/unlock device for maintenance
/enableLockedMode
/disableLockedMode

// Show message in an overlay
/setOverlayMessage?text=[text]

// Rooted devices only
/shutdownDevice
/runRootCommand?command=[command]
/runSuCommand?command=[command]
  
// Rooted and provisioned devices only
/rebootDevice
Get Stats, Screenshot and Camshot
// Load full usage stats CSV file
/loadStatsCSV

// Get screenshot image (PNG), not for videos or other apps
/getScreenshot

// Get camshot image (requires Motion Detection)
/getCamshot
Use TTS and Multimedia
// Text to speech
/textToSpeech?text=[text]
/textToSpeech?text=[text]&locale=[locale]
/textToSpeech?text=[text]&locale=[locale]&engine=[engine]
/textToSpeech?text=[text]&locale=[locale]&engine=[engine]&queue=[0|1]
/stopTextToSpeech

// Play sounds/video and change audio volume
// Audio Streams: 0 – Voice Call, 1 – System, 2 –  Ring, 3 – Music, 4 – Alarm, 5 – Notification, 6 – Bluetooth, 8 – DTMF, 9  – TTS, 10 – Accessibility
/setAudioVolume?level=[0-100]&stream=[0-10]
/playSound?url=[url]&loop=[true|false]&stream=[0-10]
/stopSound
/playVideo?url=[url]&loop=[0|1]&showControls=[0|1]&exitOnTouch=[0|1]&exitOnCompletion=[0|1]
/stopVideo
Manage Settings
// Change any of 350+ Fully settings, look in Remote Admin for keys
// New values will be applied immediately
/setBooleanSetting?key=[key]&value=[true|false]
/setStringSetting?key=[key]&value=[value]

// Get current setting values
/listSettings?type=json

// Import JSON settings file from URL or file
/importSettingsFile?url=[url]
File Management
// Download and upzip file from URL to directory  
// If dir is not specified use shared storage root (if Android 9 or older, or All Files Access granted), otherwise use app specific storage root
/loadZipFile?url=[url]&dir=[dir]

// Download/delete local files
/deleteFile?filename=[filename]
/downloadFile?filename=[filename]
/deleteFolder?foldername=[foldername]