Skip to main content
GET
/
browser
/
sessions
/
{id}
/
proxy
Get Session Proxy
curl --request GET \
  --url https://api.example.com/browser/sessions/{id}/proxy
{
  "enabled": true,
  "provider": "<string>",
  "location": "<string>",
  "sticky": true
}

Overview

Returns the session’s current proxy state — whether a proxy is active, which provider and location it uses, and whether the exit IP is sticky. Returns enabled: false for sessions running without a managed proxy.

Path Parameters

id
string
required
Browser session ID (UUID).

Example Request

curl -X GET "https://api.scrapengine.io/api/v1/browser/sessions/baa3f390-fa6e-4a24-b84a-a575a5f3a9c7/proxy" \
  -H "Authorization: Bearer $SCRAPENGINE_API_KEY"

Response

Success Response (200)

enabled
boolean
Whether a proxy is currently active for this session.
provider
string
Proxy provider — oxylabs or evomi. Absent when enabled is false.
location
string
Country code of the exit IP.
sticky
boolean
Whether the exit IP is held for the life of the session.
Example Response:
{
  "enabled": true,
  "provider": "oxylabs",
  "location": "us",
  "sticky": true
}

Error Responses

StatusDescription
401Unauthorized — invalid or missing API key.
404Session not found or not owned by the caller.