createWithId(...args)

Creates and forwards a proxy on the specified port, identified by proxyId and configured with the given plan and action type.

async createWithId(port, proxyId, plan, actionType)

Parameters

  • port (number) – The local port to forward.

  • proxyId (string) – ID of the proxy to forward. This also acts as the requestId for receiving success/failure status in event callbacks.

  • plan (string) – ID of the plan to use (default: "1").

  • actionType (string) – User action type (default: "manual").

Return Value

number – Returns 0 on success.

Example

// example

sdk.createWithId(60000, "677e2c4517f247bc89dd66a4", "1", "manual");

Last updated

Was this helpful?