Local API reference
Select the documentation matching your ZYBrowser client version. This entry opens the latest documented version by default.
Enable Local API and obtain an API Key
Authentication: send your API Key in the Authorization header.
Authorization: Bearer <api-key>Requests run on the computer with the desktop client. The examples can be copied into local scripts; this site does not send API requests.
Service
Browser profiles
- GETList browser profiles
/api/v1/browsers - POSTCreate a browser profile
/api/v1/browsers - DELETEDelete browser profiles in a batch (move to recycle bin)
/api/v1/browsers - GETGet browser profile details
/api/v1/browsers/{envId} - PUTEdit a browser profile
/api/v1/browsers/{envId} - DELETEDelete a browser profile (move to recycle bin)
/api/v1/browsers/{envId} - DELETEPermanently delete a browser profile
/api/v1/browsers/{envId}/permanent - GETGet the complete browser profile configuration
/api/v1/browsers/{envId}/profile - DELETEPermanently delete browser profiles in a batch
/api/v1/browsers/permanent - POSTRestart a browser profile
/api/v1/browsers/restart - POSTRestart browser profiles in a batch
/api/v1/browsers/restart/batch - POSTStart a browser profile
/api/v1/browsers/start - POSTStart browser profiles in a batch
/api/v1/browsers/start/batch - POSTStop a browser profile
/api/v1/browsers/stop - POSTStop all browser profiles
/api/v1/browsers/stop/all - POSTStop browser profiles in a batch
/api/v1/browsers/stop/batch
Profile configuration options
- GETList font options
/api/v1/profile-options/fonts - GETGet a specified number of random fonts
/api/v1/profile-options/fonts/random - GETList memory and CPU presets
/api/v1/profile-options/hardware - GETGet random memory and CPU values
/api/v1/profile-options/hardware/random - GETList browser engines supported on this computer
/api/v1/profile-options/kernels - GETList operating systems supported by a browser engine
/api/v1/profile-options/kernels/{kernel_version}/systems - GETList language options
/api/v1/profile-options/languages - GETList screen resolution presets
/api/v1/profile-options/screens - GETGet a random screen resolution
/api/v1/profile-options/screens/random - GETGet a random operating system supported by a browser engine
/api/v1/profile-options/systems/random - GETList time zone options
/api/v1/profile-options/timezones - GETGet random compatible WebGL metadata
/api/v1/profile-options/webgl/random
Profile groups
Proxies
- GETList proxies
/api/v1/proxies - POSTCreate a proxy
/api/v1/proxies - GETGet proxy details
/api/v1/proxies/{proxy_id} - PUTUpdate a proxy
/api/v1/proxies/{proxy_id} - DELETEDelete a proxy
/api/v1/proxies/{proxy_id} - PUTReplace proxy profile bindings
/api/v1/proxies/{proxy_id}/browsers - POSTCheck a saved proxy
/api/v1/proxies/{proxy_id}/check - POSTCheck a temporary proxy
/api/v1/proxies/check
Platform accounts
- GETList account platforms
/api/v1/account-platforms - POSTCreate a custom account platform
/api/v1/account-platforms - GETList accounts
/api/v1/accounts - POSTCreate an account
/api/v1/accounts - GETGet account details
/api/v1/accounts/{account_id} - PUTUpdate an account
/api/v1/accounts/{account_id} - DELETEDelete an account
/api/v1/accounts/{account_id}