Skip to content

Quick create browser profile

Request

Create 1 to 200 browser profiles that share one configuration.

  • Preconditions: the team plan must have enough remaining profiles, and the daily creation quota must not be exhausted. isEncrypt=1 requires the team to have an encryption key configured. Firefox is only available on Windows and macOS. A groupId must already exist, but passing groupName instead creates the group automatically.
  • Effect: inserts the profiles, consumes plan capacity, and increments the daily creation counter. Passing proxy connection details can also create a proxy record.
  • Completion: synchronous. data holds the new profile IDs in creation order.
  • Retry: not idempotent, and there is no idempotency key. Confirm with /env/page instead of retrying.
  • Open API: no client information is read, so you may pin the machine spec with systemBitType and architecture. Kernels come from the published set only. Concurrent calls are not serialized, so two parallel requests can both pass the quota check.

Documented business errors: 19002, 19063, 19064, 19104, 19106, 19107, 19108, 19111, 19112, 14023. See Error Codes for what each code means. Any operation can additionally return the common codes.

Security
OpenApiBearer
Bodyapplication/jsonrequired
quantityinteger, [ 1 .. 200 ]required

Number of profiles to create.

Example:1
browserTypeIdinteger(BrowserType)required

Browser type:

  • 1 — Chrome
  • 2 — Firefox
Enum:12
Example:1
operatorSystemIdinteger(OperatingSystem)required

Operating system:

  • 1 — Windows
  • 2 — macOS
  • 3 — Android
  • 4 — iOS
  • 5 — Linux
Enum:12345
Example:1
groupIdstring^\d+$

Existing group ID. 0 means ungrouped.

Example:"0"
groupNamestring, <= 50 characters

Group name. The group is looked up or created automatically when supplied.

Example:"Marketing"
isEncryptinteger(ToggleFlag)

Whether to encrypt the profile. Defaults to 0:

  • 0 — not encrypted
  • 1 — encrypted
Enum:01
Example:0
browserCoreinteger, >= 0

Kernel major version. Defaults to 0, which selects a published kernel automatically.

Example:0
systemBitTypeinteger(SystemBitType)

System bitness. Defaults to 1:

  • 0 — 32-bit
  • 1 — 64-bit
Default:1
Enum:01
Example:1
architectureinteger(Architecture)

CPU architecture. Defaults to 0:

  • 0 — x86
  • 1 — ARM
Default:0
Enum:01
Example:0
proxyobject(ProxyInput)

Proxy connection details. When proxyId refers to an existing proxy, that proxy is reused; otherwise a new proxy is created from these fields.

curl -i -X POST \
  https://api.morelogin.com/env/create/quick \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 1,
    "browserTypeId": 1,
    "operatorSystemId": 1,
    "groupName": "Marketing",
    "isEncrypt": 0,
    "browserCore": 0,
    "systemBitType": 1,
    "architecture": 0
  }'

Responses

Success

Bodyapplication/json
codeintegerrequired

Return result code. 0 means success; other codes indicate exceptions.

Example:0
msgstring or nullrequired

Error message. Usually null on success.

Example:null
requestIdstring

Operation request ID. This field may be present when the request passes through the API gateway.

Example:"1d4f3ea968664593860b94b35d4ebf5e"
dataArray of stringsrequired

IDs of the created profiles, in creation order.

Response
{ "code": 0, "msg": null, "data": [ "1800000000000001" ], "requestId": "1d4f3ea968664593860b94b35d4ebf5e" }