Create Proxy Session with Oxylabs API

Pipedream makes it easy to connect APIs for Oxylabs and 2,700+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Proxy Session with the Oxylabs API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Proxy Session with the Oxylabs API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Proxy Session action
1. Connect your Oxylabs account
2. Configure Username
3. Configure Password
4. Configure Session ID
5. Optional- Configure Country Code
6. Optional- Configure City
7. Optional- Configure State
8. Optional- Configure Session Time
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Proxy Session with Oxylabs API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Oxylabs

Try it

Create Proxy Session with Oxylabs API on New Submission from Typeform API

Typeform + Oxylabs

Try it

Create Proxy Session with Oxylabs API on New Submission (Instant) from Jotform API

Jotform + Oxylabs

Try it

Create Proxy Session with Oxylabs API on New Scheduled Tasks from Pipedream API

Pipedream + Oxylabs

Try it

Create Proxy Session with Oxylabs API on New Download Counts from npm API

npm + Oxylabs

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Proxy Session on Oxylabs

Description:Establish a proxy session using the Residential Proxy endpoint. [See the documentation](https://developers.oxylabs.io/proxies/residential-proxies/session-control#establishing-session)

Version:0.0.1

Key:oxylabs-create-proxy-session

View on GitHub

Code#

import oxylabs from "../../oxylabs.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "oxylabs-create-proxy-session",
  name: "Create Proxy Session",
  description: "Establish a proxy session using the Residential Proxy endpoint. [See the documentation](https://developers.oxylabs.io/proxies/residential-proxies/session-control#establishing-session)",
  version: "0.0.1",
  type: "action",
  props: {
    oxylabs,
    username: {
      type: "string",
      label: "Username",
      description: "The username for the proxy user",
    },
    password: {
      type: "string",
      label: "Password",
      description: "The password for the proxy user",
    },
    sessid: {
      type: "string",
      label: "Session ID",
      description: "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.",
    },
    cc: {
      type: "string",
      label: "Country Code",
      description: "Case insensitive country code in 2-letter [3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "Case insensitive city name in English. This parameter must be accompanied by cc for better accuracy.",
      optional: true,
    },
    st: {
      type: "string",
      label: "State",
      description: "Case insensitive US state name with us_ in the beginning, for example, `us_california`, `us_illinois`",
      optional: true,
    },
    sstime: {
      type: "string",
      label: "Session Time",
      description: "Session time in minutes. The session time parameter keeps the same IP for a certain period. The maximum session time is 30 minutes.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      username,
      password,
      sessid,
      cc,
      city,
      st,
      sstime,
    } = this;

    if (city && !cc) {
      throw new ConfigurationError("City must be accompanied by country code");
    }

    const proxyUrl = `http://customer-${username}${cc
      ? `-cc-${cc}`
      : ""}${city
      ? `-city-${city}`
      : ""}${st
      ? `-st-${st}`
      : ""}${sessid
      ? `-sessid-${sessid}`
      : ""}${sstime
      ? `-sstime-${sstime}`
      : ""}:${password}@pr.oxylabs.io:7777`;
    const response = await this.oxylabs.createSession({
      $,
      proxyUrl,
    });
    $.export("$summary", `Successfully created proxy session with session ID: ${this.sessid}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Oxylabs	`oxylabs`	`app`	This component uses the Oxylabs app.
Username	`username`	`string`	The username for the proxy user
Password	`password`	`string`	The password for the proxy user
Session ID	`sessid`	`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.
Country Code	`cc`	`string`	Case insensitive country code in 2-letter 3166-1 alpha-2 format
City	`city`	`string`	Case insensitive city name in English. This parameter must be accompanied by cc for better accuracy.
State	`st`	`string`	Case insensitive US state name with us_ in the beginning, for example, `us_california`, `us_illinois`
Session Time	`sstime`	`string`	Session time in minutes. The session time parameter keeps the same IP for a certain period. The maximum session time is 30 minutes.