Sessions

Create running browser session to use remotely.

Last updated 3 months ago

GetSession

get

Retrieves detailed information about a specific browser session, including its status, settings, and remaining lease time.

Authorizations

Path parameters

modestringRequired

sessionUUIDstringRequiredExample: dcf639f1-1ecb-4208-8ef2-02d7a02b0997

Responses

200

Session details

application/json

get

GET /{mode}/v1/sessions/{sessionUUID} HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Accept: */*

200

Session details

{
  "sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "currentLeaseTime": 5,
  "isVncEnabled": true,
  "createdAt": "2025-02-04T11:06:29.731Z",
  "updatedAt": "2025-02-04T11:06:29.731Z",
  "driver": "puppeteer",
  "status": "running",
  "vncMode": "rw"
}

EndSession

delete

Terminates a browser session immediately, releasing all associated resources and ending the lease.

Authorizations

Path parameters

modestringRequired

sessionUUIDstringRequiredExample: dcf639f1-1ecb-4208-8ef2-02d7a02b0997

Responses

200

Session terminated successfully

application/json

Responseobject

delete

DELETE /{mode}/v1/sessions/{sessionUUID} HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Accept: */*

200

Session terminated successfully

{}

ListSessions

get

Retrieves a list of all active browser sessions in your environment, including their status, VNC settings, and lease times.

Authorizations

Path parameters

modestringRequired

Responses

200

List of active browser sessions

application/json

get

GET /{mode}/v1/sessions HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Accept: */*

200

List of active browser sessions

{
  "sessions": [
    {
      "sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
      "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
      "currentLeaseTime": 5,
      "isVncEnabled": true,
      "createdAt": "2025-02-04T11:06:29.731Z",
      "updatedAt": "2025-02-04T11:06:29.731Z",
      "driver": "puppeteer",
      "status": "running",
      "vncMode": "rw"
    }
  ]
}

CreateSessionWithoutFingerprint

post

Creates a new browser session using a specified fingerprint (OPTIONAL). Configure VNC access, lease time, and other session parameters.

Authorizations

Path parameters

modestringRequired

Header parameters

X-Fingerprint-SecretstringOptionalExample: {{fingerprintSecret}}

X-Environment-IdstringOptionalExample: {{env_uuid}}

X-Environment-SecretstringOptionalExample: {{env_secret}}

Body

fingerprintUUIDstring · uuidOptionalExample: 576626a7-2953-4790-8bc5-28a2e247ac03

leaseTimeinteger · min: 1 · max: 60Required

Duration of the session lease in minutes

Example: 5

isVncEnabledbooleanRequired

Whether VNC access is enabled for this session

vncModestring · enumRequired

VNC access mode (read-write or read-only)

Possible values:

driverstring · enumRequired

Browser automation driver type

Possible values:

showMousebooleanOptional

Whether to show mouse movements

Default: false

isProxyEnabledbooleanOptional

Whether to enable proxy for this session

Default: false

Responses

200

Session created successfully

application/json

post

POST /{mode}/v1/sessions HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "leaseTime": 5,
  "isVncEnabled": true,
  "vncMode": "rw",
  "driver": "puppeteer",
  "showMouse": false,
  "isProxyEnabled": false
}

200

Session created successfully

{
  "sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
  "currentLeaseTime": 5,
  "isVncEnabled": true,
  "createdAt": "2025-02-04T11:06:29.731Z",
  "updatedAt": "2025-02-04T11:06:29.731Z",
  "driver": "puppeteer",
  "status": "running",
  "vncMode": "rw"
}

UpdateSession

patch

Updates the settings of an active browser session. Currently supports extending the lease time.

Authorizations

Path parameters

modestringRequired

sessionUUIDstringRequiredExample: dcf639f1-1ecb-4208-8ef2-02d7a02b0997

Body

newLeaseTimeintegerRequired

Responses

200

Session lease time updated successfully

application/json

Responseobject

patch

PATCH /{mode}/v1/sessions/{sessionUUID} HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "newLeaseTime": 1
}

200

Session lease time updated successfully

{}