CloudBrowser Docs
  1. Profile
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
        GET
      • Update Instance Fingerprint
        POST
    • sessions
      • Create Browser Session
      • Start Session
      • Close Session
    • files
      • Upload File
      • Download File
    • plugin
      • Upload Plugin
      • Get Plugin List
      • Update Environment Fingerprint
  • Changelog
  1. Profile

Get session list

GET
/getList

Request

Query Params
page
number 
required
Current page number, starting from 1
pageSize
number 
required
Number of items per page
sessionIds
array[string]
optional
Session ID array for filtering specific sessions

Request 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 GET '/getList?page&pageSize&sessionIds'

Responses

🟢200Success
application/json
Request successful
Body
reqId
string 
optional
code
number 
optional
msg
string 
optional
data
object 
optional
list
array [object {20}] 
optional
total
number 
optional
pageSize
number 
optional
currentPage
number 
optional
Example
{
    "reqId": "string",
    "code": 0,
    "msg": "string",
    "data": {
        "list": [
            {
                "id": 0,
                "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,
                "info": {},
                "browser": {
                    "system": "string",
                    "publicIp": "string",
                    "kernel": "string",
                    "kernelVersion": "string",
                    "proxy": {
                        "protocol": "string",
                        "host": "string",
                        "port": 0,
                        "userName": "string",
                        "password": "string"
                    }
                },
                "country": "string",
                "city": "string"
            }
        ],
        "total": 0,
        "pageSize": 0,
        "currentPage": 0
    }
}
🔴500Failed
Previous
Node.js SDK
Next
Update Instance Fingerprint
Built with