Oxylabs ACTION
Create Proxy Session
Establish a proxy session using the Residential Proxy endpoint. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Oxylabs account once, then configure and run Create Proxy Session from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "oxylabs-create-proxy-session",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
oxylabs: { authProvisionId: "apn_xxxxxxx" },
username: "Username",
password: "Password",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "oxylabs-create-proxy-session",
"configured_props": {
"oxylabs": { "authProvisionId": "apn_xxxxxxx" },
"username": "Username",
"password": "Password"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "oxylabs",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "oxylabs-create-proxy-session",
arguments: {
username: "Username",
password: "Password",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
username Username | string | The username for the proxy user Required |
password Password | string | The password for the proxy user Required |
sessid Session ID | string | Session ID to keep the same IP with upcoming queries. The session expires in 10 minutes. After that, a new IP address is assigned to that session ID. Random string, 0-9, and A-Z characters are supported. Required |
cc Country Code | string | Case insensitive country code in 2-letter 3166-1 alpha-2 format Optional |
city City | string | Case insensitive city name in English. This parameter must be accompanied by cc for better accuracy. Optional |
st State | string | Case insensitive US state name with us_ in the beginning, for example, us_california, us_illinois Optional |
sstime Session Time | string | Session time in minutes. The session time parameter keeps the same IP for a certain period. The maximum session time is 30 minutes. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- oxylabs-create-proxy-session
- Version
- 0.0.4
- App
- Oxylabs
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗