Skip to content

Local API/Data models

Main Navigation Website Download ZYBrowser User Guide

English

English

Appearance

ZYBrowser Local API

Client version

Filter endpoints and models

Overview Configure Local API

Service1

Browser profiles16

ListGET CreatePOST Batch move to recycle binDELETE DetailsGET EditPUT Move to recycle binDELETE Permanently deleteDELETE Full configurationGET Batch permanently deleteDELETE RestartPOST Batch restartPOST StartPOST Batch startPOST StopPOST Stop allPOST Batch stopPOST

Profile configuration options12

FontsGET Random fontsGET Memory and CPU presetsGET Random memory and CPUGET Browser enginesGET Operating systemsGET LanguagesGET Screen resolutionsGET Random screen resolutionGET Random operating systemGET Time zonesGET Random WebGL metadataGET

Profile groups6

ListGET CreatePOST DetailsGET UpdatePUT DeleteDELETE Move profiles to groupPOST

Proxies8

ListGET CreatePOST DetailsGET UpdatePUT DeleteDELETE Replace profile bindingsPUT Check saved proxyPOST Check temporary proxyPOST

Platform accounts7

List platformsGET Create custom platformPOST List accountsGET Create accountPOST Account detailsGET Update accountPUT Delete accountDELETE

Extensions4

My extensionsGET DetailsGET Replace profile bindingsPUT Team extensionsGET

Profile recycle bin4

ListGET Permanently deleteDELETE Empty recycle binDELETE RestorePOST

Data models80

AccountCreateRequestAccountDeleteSuccessResponseAccountDetailSuccessResponseAccountListItemAccountListSuccessResponseAccountPlatformCreateRequestAccountPlatformCreateSuccessResponseAccountPlatformListSuccessResponseAccountUpdateRequestActiveBrowserApiErrorResponseBrowserBatchDeleteRequestBrowserBatchDeleteSuccessResponseBrowserBatchPermanentDeleteRequestBrowserBatchPermanentDeleteSuccessResponseBrowserBatchRestartRequestBrowserBatchRestartSuccessResponseBrowserBatchStartRequestBrowserBatchStartSuccessResponseBrowserBatchStopRequestBrowserBatchStopSuccessResponseBrowserCreateRequestBrowserCreateSuccessResponseBrowserDeleteRequestBrowserDeleteSuccessResponseBrowserDetailSuccessResponseBrowserGroupBrowserListSuccessResponseBrowserPermanentDeleteSuccessResponseBrowserProfileDetailSuccessResponseBrowserRestartRequestBrowserRestartSuccessResponseBrowserStartRequestBrowserStartSuccessResponseBrowserStopAllRequestBrowserStopRequestBrowserStopSuccessResponseBrowserUpdateRequestBrowserUpdateSuccessResponseExtensionBindBrowsersRequestExtensionBindBrowsersSuccessResponseExtensionDetailSuccessResponseExtensionListItemExtensionListSuccessResponseGroupDeleteSuccessResponseGroupDetailSuccessResponseGroupListSuccessResponseGroupMoveBrowsersRequestGroupMoveBrowsersSuccessResponseGroupMutationRequestProfileFontListSuccessResponseProfileFontRandomSuccessResponseProfileHardwareRandomSuccessResponseProfileHardwareSuccessResponseProfileKernelListSuccessResponseProfileLanguageListSuccessResponseProfileScreenListSuccessResponseProfileScreenRandomSuccessResponseProfileSystemListSuccessResponseProfileSystemRandomSuccessResponseProfileTimezoneListSuccessResponseProfileWebglSuccessResponseProxyBindBrowsersRequestProxyBindBrowsersSuccessResponseProxyCheckRequestProxyCheckSuccessResponseProxyCreateRequestProxyDeleteSuccessResponseProxyDetailSuccessResponseProxyListItemProxyListSuccessResponseProxySavedCheckSuccessResponseProxyUpdateRequestRecycleBinClearSuccessResponseRecycleBinDeleteSuccessResponseRecycleBinListItemRecycleBinListSuccessResponseRecycleBinMutationRequestRecycleBinRestoreSuccessResponseStatusSuccessResponse

Appendix

ZYBrowser website↗

BrowserStopRequest schema

Client versionVersion overview

BrowserStopRequest

object

Fields

›stringrequired

Unique browser profile ID

Example"env_01JABCDEF1234567890"

minLength: 1

← PreviousBrowserStopAllRequest Next →BrowserStopSuccessResponse

ZYBrowser Local API documentation