Sessions
Create running browser session to use remotely.
Retrieves a list of all active browser sessions in your environment, including their status, VNC settings, and lease times.
List of active browser sessions
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /{mode}/v1/sessions HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"sessions": [
{
"sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
"fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
"currentLeaseTime": 5,
"isVncEnabled": true,
"vncPassword": "abc123def",
"createdAt": "2025-02-04T11:06:29.731Z",
"updatedAt": "2025-02-04T11:06:29.731Z",
"driver": "puppeteer",
"status": "running",
"vncMode": "rw"
}
]
}
Creates a new browser session using a specified fingerprint (OPTIONAL). Configure VNC access, lease time, and other session parameters.
{{fingerprintSecret}}
{{env_uuid}}
{{env_secret}}
576626a7-2953-4790-8bc5-28a2e247ac03
Duration of the session lease in minutes
5
Whether VNC access is enabled for this session
VNC access mode (read-write or read-only)
Browser automation driver type
Whether to show mouse movements
false
Whether to enable proxy for this session
false
Session created successfully
Bad Request
Unauthorized
Not Found
Internal Server Error
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
}
{
"sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
"fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
"currentLeaseTime": 5,
"isVncEnabled": true,
"vncPassword": "abc123def",
"createdAt": "2025-02-04T11:06:29.731Z",
"updatedAt": "2025-02-04T11:06:29.731Z",
"driver": "puppeteer",
"status": "running",
"vncMode": "rw"
}
Retrieves detailed information about a specific browser session, including its status, settings, and remaining lease time.
dcf639f1-1ecb-4208-8ef2-02d7a02b0997
Session details
Bad Request
Unauthorized
Not Found
Internal Server Error
GET /{mode}/v1/sessions/{sessionUUID} HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Accept: */*
{
"sessionUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
"fingerprintUUID": "576626a7-2953-4790-8bc5-28a2e247ac03",
"currentLeaseTime": 5,
"isVncEnabled": true,
"vncPassword": "abc123def",
"createdAt": "2025-02-04T11:06:29.731Z",
"updatedAt": "2025-02-04T11:06:29.731Z",
"driver": "puppeteer",
"status": "running",
"vncMode": "rw"
}
Terminates a browser session immediately, releasing all associated resources and ending the lease.
dcf639f1-1ecb-4208-8ef2-02d7a02b0997
Session terminated successfully
Bad Request
Unauthorized
Not Found
Internal Server Error
DELETE /{mode}/v1/sessions/{sessionUUID} HTTP/1.1
Host: api.tasknet.co
X-Api-Key: YOUR_API_KEY
Accept: */*
{}
Updates the settings of an active browser session. Currently supports extending the lease time.
dcf639f1-1ecb-4208-8ef2-02d7a02b0997
Session lease time updated successfully
Bad Request
Unauthorized
Not Found
Internal Server Error
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
}
{}
Last updated