CloudBrowser Docs
  1. sessions
CloudBrowser Docs
  • Documentation
    • Introduction
      • What is CloudBrowser?
      • What is Headless browsers?
      • Getting started
      • Playwright
    • Fundamentals
      • Create a Browser Session
      • Use a Browser Profile
      • Manage a Browser Profile
    • Features
      • Stealth Mode
      • Proxies
      • Live View
      • Session Inspector
      • Downloads
      • Uploads
    • User Cases
      • Form Submissions
      • Web Scraping
      • Automated Tests
    • Guides
      • Improving Performance
      • Optimizing Cost
      • Browser Regions
      • Using Profile ID
      • Plans and Pricing
      • Concurrency & Rate Limits
      • Handling Authentication
      • Enerprise Security
    • Inegrations
      • Get Started with Intergrations
      • CloudBrowser MCP Server
      • CloudBrowser MCP Service
  • APIs and SDKs
    • Node.js SDK
    • Profile
      • Get session list
      • Update Instance Fingerprint
    • sessions
      • Create Browser Session
        POST
      • Start Session
        POST
      • Close Session
        POST
    • files
      • Upload File
      • Download File
    • plugin
      • Upload Plugin
      • Get Plugin List
      • Update Environment Fingerprint
  1. sessions

Create Browser Session

POST
/sessions
sessions
Create a new browser session instance

Request

Body Params application/json

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/sessions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey": "string",
    "sessionId": "string"
}'

Responses

🟢200Success
application/json
Session created successfully
Body

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"
}
Previous
Update Instance Fingerprint
Next
Start Session
Built with