Create Browser Session - CloudBrowser Docs

Request

Body Params application/json

apiKey

string

required

API key

sessionId

string

required

Session ID

Example

{
    "apiKey": "string",
    "sessionId": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/sessions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey": "string",
    "sessionId": "string"
}'

Responses

🟢200Success

application/json

Session created successfully

Body

id

integer <int64>

optional

Unique identifier

appId

string

optional

Application ID

orderno

string

optional

Order ID

userId

string

optional

User ID

companyId

string

optional

Company ID

apiKey

string

optional

API key

sessionId

string

optional

Instance ID

sessionName

string

optional

Instance name

keepalive

integer

optional

Maximum keep-alive connections

keepaliveTimeout

integer

optional

Maximum keep-alive timeout

productId

string

optional

Product ID

cloudId

string

optional

Cloud host ID

browserUrl

string

optional

Instance URL

status

integer

optional

Status (1-running, 2-stopped/idle, 3-starting, 4-stopping, 8-expired, 9-terminated)

healthy

integer

optional

Health status

expiredType

integer

optional

Expiration type

expired

integer <int64>

optional

Expiration time

totalDuration

integer <int64>

optional

Total duration

duration

integer <int64>

optional

Duration

clientNum

integer

optional

Client count

browser

object

optional

Browser information

system

string

optional

Operating system

publicIp

string

optional

Public IP

kernel

string

optional

Browser kernel

kernelVersion

string

optional

Kernel version

proxy

object

optional

Proxy settings

site_accounts

array [object {3}]

optional

cookies

object

optional

Cookies information

extensions

array[string]

optional

Array of plugin IDs

country

string

optional

Country

city

string

optional

City

Example

{
    "id": 0,
    "appId": "string",
    "orderno": "string",
    "userId": "string",
    "companyId": "string",
    "apiKey": "string",
    "sessionId": "string",
    "sessionName": "string",
    "keepalive": 0,
    "keepaliveTimeout": 0,
    "productId": "string",
    "cloudId": "string",
    "browserUrl": "string",
    "status": 0,
    "healthy": 0,
    "expiredType": 0,
    "expired": 0,
    "totalDuration": 0,
    "duration": 0,
    "clientNum": 0,
    "browser": {
        "system": "string",
        "publicIp": "string",
        "kernel": "string",
        "kernelVersion": "string",
        "proxy": {
            "protocol": "string",
            "host": "string",
            "port": 0,
            "userName": "string",
            "password": "string"
        },
        "site_accounts": [
            {
                "user": "string",
                "pwd": "string",
                "site": "string"
            }
        ]
    },
    "cookies": {},
    "extensions": [
        "string"
    ],
    "country": "string",
    "city": "string"
}