Skip to content
Local APIDocumentation

Business and HTTP error codes ​

Successful responses use code = 0; failed responses use code > 0. The HTTP status and business code are separate values. Use the endpoint, message and current state to distinguish errors that share a code.

Business error codes ​

codeMessage / meaning
40003missing host header
40004host is not allowed
40005host port is not allowed
40006invalid origin
40007origin is not allowed
40008origin port is not allowed
40010invalid browser path parameters
40011Invalid browser profile start parameters or missing env_id
40012Invalid browser profile stop parameters or missing env_id
40013invalid browser list query
40014invalid browser batch start request
40015invalid browser batch stop request
40016Invalid browser profile restart parameters or missing env_id
40017invalid browser stop-all request
40018invalid browser batch restart request
40019invalid browser create request
40020Invalid parameters for updating a browser profile or querying the group list
40021invalid group path parameters
40022invalid group create request
40023invalid group update request
40024invalid group browser move request
40025Invalid parameters for deleting one or more browser profiles
40026invalid browser permanent delete request
40030invalid proxy list query
40031invalid proxy path parameters
40032invalid proxy create request
40033invalid proxy host or IP protocol
40034invalid proxy update request
40035invalid proxy check request
40036invalid proxy browser binding request
40040invalid extension list query
40041invalid extension path parameters
40042invalid extension browser binding request
40050invalid recycle bin list query
40051invalid recycle bin restore request
40052invalid recycle bin delete request
40060Invalid browser kernel query or path parameters
40061Invalid fingerprint option or font list query parameters
40062invalid random WebGL option query
40063invalid random profile font query
40070invalid account list query
40071invalid account path parameters
40072invalid account create request
40073Invalid account update parameters, including a missing platform_id when changing the account type
40074invalid account platform list query
40075invalid account platform create request
40101missing api key
40102empty api key
40103invalid api key
40104backend session unavailable
40105backend permission denied
40301operation is not permitted
40400api endpoint not found
40401browser environment not found
40402group not found
40403proxy not found
40404extension not found
40405recycled browser environment not found
40406profile kernel option not found
40407profile system option not found
40408account not found
40409account platform not found
40901browser environment exceeds package limit
40902browser kernel is unsupported on this platform
40903browser environment is not active
40904The operation is restricted because the browser profile uses pipe transport (close it and start it through Local API to obtain an external WebSocket endpoint), or because the default group cannot be deleted
40905default group cannot be updated
40907group still contains browsers
40911group already exists
40912proxy mode cannot be changed
40913managed proxy cannot be updated
40914managed proxy cannot be deleted
40915browser environment package limit exceeded
40916recycled browser environment is still active
40917custom account platform already exists
40918browser environment limit exceeded
40919only one account per platform can be bound to a browser
40920browser environment is still active
42201failed to extract proxy endpoint from proxy API URL
42202browser kernel, system and User-Agent are not compatible
42203invalid proxy configuration
42204invalid account configuration
50001Local API encountered an internal error or its runtime status is unavailable
50002active browser endpoint unavailable
50003Failed to start or restart the browser profile
50004active browser group unavailable
50005browser environment did not stop
50201Failed to load browser profiles or their details because the request failed, the returned data is invalid, or the processing limit was exceeded
50202failed to load supported kernels
50203Browser profile startup preparation failed, the backend rejected startup, or the returned data is invalid
50204failed to open browser URL
50205Failed to create the browser profile or the creation result is invalid
50206Failed to update the browser profile or the update result is invalid
50207Failed to delete browser profiles or move them to the recycle bin
50208Failed to permanently delete browser profiles
50209Failed to load the full browser profile configuration or the returned data is invalid
50210A group operation or related browser profile lookup failed, the returned data is invalid, or the group list exceeds the processing limit
50211Failed to create the group or retrieve the creation result
50212failed to update group
50213failed to delete group
50214failed to move browsers to group
50215default group unavailable
50220Failed to load proxies, the returned data is invalid, or the proxy list exceeds the processing limit
50221failed to create proxy
50222failed to update proxy
50223failed to delete proxy
50224Failed to check the proxy, refresh its endpoint, or update its check status
50225failed to bind proxy environments
50230Failed to load extensions, the returned data is invalid, or the extension list exceeds the processing limit
50231Failed to update browser profiles bound to the extension or retrieve the update result
50240Failed to load the recycle bin, the returned data is invalid, or the list exceeds the processing limit
50241failed to restore browser environments
50242failed to permanently delete browser environments
50243Failed to clear the recycle bin or load the browser profiles to be cleared
50250Failed to load fingerprint options or the returned kernel, system, or User-Agent options are invalid
50251Failed to load a random WebGL option or the returned data is invalid
50252Failed to load the font list or the returned data is invalid
50253Failed to load random fonts or the returned data is invalid
50260Failed to load accounts or the returned data is invalid
50261failed to create account
50262failed to update account
50263failed to delete account
50264Failed to retrieve account details, including after creating or updating an account
50265Failed to load account platforms or the returned data is invalid
50266Failed to create the account platform or the returned data is invalid
50301main client window is unavailable
50302Local browser settings are unavailable or invalid
50303browser kernel is not installed locally
50304browser extension is not installed locally:
50305The operation is temporarily unavailable because browser profile cache cleanup is in progress or the internal local server is unavailable
50306failed to delete browser environment cache
50307profile options are unavailable on this platform

Error response ​

FieldTypeDescription
codeintegerPositive business error code.
messagestringSpecific error details.
dataobject | nullAdditional error details, or null when no details are available.
request_idstringRequest trace ID, also in X-Request-Id.

Possible fields in data: env_id (string), env_ids (string[]), status (string), issues (object[]). Each validation issue has code (string), path (string[]) and message (string). The fields returned depend on the specific error.

Batch requests can return HTTP 200 / code = 0 while individual items fail. Inspect each item’s success and error. Item errors appear in data.items[].error; additional details, when present, belong to that error object. Runtime errors may also be passed through.

HTTP status codes ​

HTTPDescription
400Invalid request or parameters
401Missing or invalid API Key
403Request forbidden by access or security rules
404Resource or route not found
409Operation conflicts with the current state
422Request validation failed
500Internal error
502Upstream service error
503Service unavailable
ZYBrowser Local API documentation