Skip to main content

Introducing Proxy Configuration Support in TypeScript SDKs

· One min read

We’ve added support for configuring proxy servers in the generated TypeScript SDKs.

This new feature allows developers to route API requests through designated proxy servers, improving compatibility with enterprise networks, secure environments, or setups where traffic must pass through a proxy.

What's New?​

In many organizations, all outbound traffic is required to go through a proxy for monitoring and security purposes. This release introduces full proxy support, enabling developers to configure the SDK to send HTTP requests via a specified proxy server.

Developers can set proxy details during SDK client initialization using the proxySettings field in httpClientOptions.

TypeScript SDK Client initialization​

const client = new Client({
  httpClientOptions: {
    proxySettings: {
      address: 'http://localhost',
      port: 8080,
      auth: {
        username: 'admin',
        password: 'password123'
      }
    }
  }
});

Proxy Configuration Options​

  • address: The full address of the proxy server.
  • port: The port on which the proxy server is listening.
  • auth: Credentials for proxy authentication (username and password).

Learn more about proxy configuration feature