Start browser profile

API Reference

Request

Used to start the profile; you must specify the profile ID. After successful startup, you can obtain the profile debug interface for executing Selenium and Puppeteer automation. For Selenium, use the WebDriver matching the corresponding kernel version. The WebDriver path can be retrieved from the response after profile startup. Requires MoreLogin client version 2.15.0 or higher.

Bodyapplication/jsonrequired

envIdstring

Environment ID. At least one of envId or uniqueId must be provided. If both are given, envId takes precedence.

Example:"1993244721490239488"

uniqueIdinteger

Environment serial number (small integer ID). At least one of envId or uniqueId must be provided. If both are given, envId takes precedence.

Example:1

encryptKeystring

Encryption key. Required only if end-to-end encryption is enabled for the environment.

Example:"xxx"

isHeadlessboolean

Whether to start in headless mode. Defaults to false if omitted. Note: Requires client version v2.36.0 or higher.

Example:false

cdpEvasionboolean

Enable CDP fingerprint evasion to reduce detection risk. Only applies to PC environments. Default:false. Note: Requires client version v2.36.0 or higher.

Example:false

closeCheckIPPageboolean

Whether to skip opening the detection page. true: Proxy detection before execution false: Proxy detection after execution Note: Requires client version v2.56.0 or higher.

Example:false

checkIPErrorHandleinteger

Action to take if proxy detection fails Numeric type: 1 or 2 1: Do not start the environment if proxy detection fails 2: Start the environment even if proxy detection fails If closeCheckIPPage is passed a parameter, this parameter is omitted; default: 1 Note: Requires client version v2.56.0 or higher.

Example:1

POST

/api/env/start

curl -i -X POST \
  http://127.0.0.1:40000/api/env/start \
  -H 'Content-Type: application/json' \
  -d '{
    "envId": "1993244721490239488",
    "isHeadless": false,
    "cdpEvasion": true
  }'

Responses

Headers

any

Bodyapplication/json

codeinteger

msgstring

dataobjectrequired

Response

{
  "code": 0,
  "msg": "string",
  "data": {
    "envId": "string",
    "debugPort": "string",
    "type": "string",
    "version": 0,
    "webdriver": "string"
  }
}