Service endpoint configuration: Client-side SDKs

Client-side SDKs

This feature is available in the following client-side SDKs:

.NET (client-side)
Android
C++ (client-side)
Electron
Flutter
iOS
JavaScript
Node.js (client-side)
React Native
React Web
Roku

.NET (client-side)

Expand .NET (client-side) code sample

To configure an alternate service endpoint for the SDK, use the ServiceEndpoints builder method to specify the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      var config = Configuration
          .Builder("example-mobile-key", ConfigurationBuilder.AutoEnvAttributes.Enabled)
          .ServiceEndpoints(Components.ServiceEndpoints()
            .RelayProxy("https://your-relay-proxy.com:8030"))
          .Build();

      var config = Configuration
          .Builder("example-mobile-key", ConfigurationBuilder.AutoEnvAttributes.Enabled)
          .ServiceEndpoints(Components.ServiceEndpoints()
            .Streaming("https://clientstream.launchdarkly.us")
            .Polling("https://clientsdk.launchdarkly.us")
            .Events("https://events.launchdarkly.us"))
          .Build();

      var config = Configuration
          .Builder("example-mobile-key", ConfigurationBuilder.AutoEnvAttributes.Enabled)
          .ServiceEndpoints(Components.ServiceEndpoints()
            .Streaming("https://clientstream.eu.launchdarkly.com")
            .Polling("https://clientsdk.eu.launchdarkly.com")
            .Events("https://events.eu.launchdarkly.com"))
          .Build();

Android

Expand Android code sample

To configure an alternate service endpoint for the SDK, use the streamUri, pollUri, and eventsUri builder methods to specify the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
        .mobileKey("example-mobile-key")
        .serviceEndpoints(
          Components.serviceEndpoints()
            .relayProxy("https://your-relay-proxy.com:8030")
        )
        .build();

      LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
        .mobileKey("example-mobile-key")
        .serviceEndpoints(
          Components.serviceEndpoints()
            .streaming("https://clientstream.launchdarkly.us")
            .polling("https://clientsdk.launchdarkly.us")
            .events("https://events.launchdarkly.us")
        )
        .build();

      LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
        .mobileKey("example-mobile-key")
        .serviceEndpoints(
          Components.serviceEndpoints()
            .streaming("https://clientstream.eu.launchdarkly.com")
            .polling("https://clientsdk.eu.launchdarkly.com")
            .events("https://events.eu.launchdarkly.com")
        )
        .build();

      val ldConfig: LDConfig = LDConfig.Builder(AutoEnvAttributes.Enabled)
        .mobileKey("example-mobile-key")
        .serviceEndpoints(
          Components.serviceEndpoints()
            .relayProxy("https://your-relay-proxy.com:8030")
        )
        .build();

      val ldConfig: LDConfig = LDConfig.Builder(AutoEnvAttributes.Enabled)
        .mobileKey("example-mobile-key")
        .serviceEndpoints(
          Components.serviceEndpoints()
            .streaming("https://clientstream.launchdarkly.us")
            .polling("https://clientsdk.launchdarkly.us")
            .events("https://events.launchdarkly.us")
        )
        .build();

      val ldConfig: LDConfig = LDConfig.Builder(AutoEnvAttributes.Enabled)
        .mobileKey("example-mobile-key")
        .serviceEndpoints(
          Components.serviceEndpoints()
            .streaming("https://clientstream.eu.launchdarkly.com")
            .polling("https://clientsdk.eu.launchdarkly.com")
            .events("https://events.eu.launchdarkly.com")
        )
        .build();

C++ (client-side)

Expand C++ (client-side) code sample

To configure an alternate service endpoint for the SDK, use StreamingBaseUrl, PollingBaseUrl, and EventsBaseUrl to specify the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      auto config_builder = client_side::ConfigBuilder("example-mobile-key");
      config_builder.ServiceEndpoints()
          .StreamingBaseUrl("https://your-relay-proxy.com:8030")
          .PollingBaseUrl("https://your-relay-proxy.com:8030")
          .EventsBaseUrl("https://your-relay-proxy.com:8030")
      auto config = config_builder.Build();

      LDClientConfigBuilder builder = LDClientConfigBuilder_New("example-mobile-key");
      LDClientConfigBuilder_ServiceEndpoints_StreamingBaseURL(builder, "https://your-relay-proxy.com:8030")
      LDClientConfigBuilder_ServiceEndpoints_PollingBaseURL(builder, "https://your-relay-proxy.com:8030")
      LDClientConfigBuilder_ServiceEndpoints_EventsBaseURL(builder, "https://your-relay-proxy.com:8030")
      LDClientConfig config;

      LDStatus status = LDClientConfigBuilder_Build(builder, &config);

      if (!LDStatus_Ok(status)) {
          /* an error occurred, config is not valid */
      }

      auto config_builder = client_side::ConfigBuilder("example-mobile-key");
      config_builder.ServiceEndpoints()
          .StreamingBaseUrl("https://clientstream.launchdarkly.us")
          .PollingBaseUrl("https://clientsdk.launchdarkly.us")
          .EventsBaseUrl("https://events.launchdarkly.us")
      auto config = config_builder.Build();

      LDClientConfigBuilder builder = LDClientConfigBuilder_New("example-mobile-key");
      LDClientConfigBuilder_ServiceEndpoints_StreamingBaseURL(builder, "https://clientstream.launchdarkly.us")
      LDClientConfigBuilder_ServiceEndpoints_PollingBaseURL(builder, "https://clientsdk.launchdarkly.us")
      LDClientConfigBuilder_ServiceEndpoints_EventsBaseURL(builder, "https://events.launchdarkly.us")
      LDClientConfig config;

      LDStatus status = LDClientConfigBuilder_Build(builder, &config);

      if (!LDStatus_Ok(status)) {
          /* an error occurred, config is not valid */
      }

      auto config_builder = client_side::ConfigBuilder("example-mobile-key");
      config_builder.ServiceEndpoints()
          .StreamingBaseUrl("https://clientstream.eu.launchdarkly.com")
          .PollingBaseUrl("https://clientsdk.eu.launchdarkly.com")
          .EventsBaseUrl("https://events.eu.launchdarkly.com")
      auto config = config_builder.Build();

      LDClientConfigBuilder builder = LDClientConfigBuilder_New("example-mobile-key");
      LDClientConfigBuilder_ServiceEndpoints_StreamingBaseURL(builder, "https://clientstream.eu.launchdarkly.com")
      LDClientConfigBuilder_ServiceEndpoints_PollingBaseURL(builder, "https://clientsdk.eu.launchdarkly.com")
      LDClientConfigBuilder_ServiceEndpoints_EventsBaseURL(builder, "https://events.eu.launchdarkly.com")
      LDClientConfig config;

      LDStatus status = LDClientConfigBuilder_Build(builder, &config);

      if (!LDStatus_Ok(status)) {
          /* an error occurred, config is not valid */
      }

To learn more, read ServiceEndpoints.

Electron

Expand Electron code sample

To configure an alternate service endpoint for the SDK, use the streamUrl, baseUrl, and eventsUrl options to specify the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      const options = {
        streamUrl: 'https://your-relay-proxy.com:8030',
        baseUrl: 'https://your-relay-proxy.com:8030',
        eventsUrl: 'https://your-relay-proxy.com:8030'
      };

      import * as LDElectron from 'launchdarkly-electron-client-sdk';

      const options: LDElectron.LDOptions = {
        streamUrl: 'https://your-relay-proxy.com:8030',
        baseUrl: 'https://your-relay-proxy.com:8030',
        eventsUrl: 'https://your-relay-proxy.com:8030',
      };

      const options = {
        streamUrl: 'https://clientstream.launchdarkly.us',
        baseUrl: 'https://clientsdk.launchdarkly.us',
        eventsUrl: 'https://events.launchdarkly.us'
      };

      import * as LDElectron from 'launchdarkly-electron-client-sdk';

      const options: LDElectron.LDOptions = {
        streamUrl: 'https://clientstream.launchdarkly.us',
        baseUrl: 'https://clientsdk.launchdarkly.us',
        eventsUrl: 'https://events.launchdarkly.us'
      };

      const options = {
        streamUrl: 'https://clientstream.eu.launchdarkly.com',
        baseUrl: 'https://clientsdk.eu.launchdarkly.com',
        eventsUrl: 'https://events.eu.launchdarkly.com'
      };

      import * as LDElectron from 'launchdarkly-electron-client-sdk';

      const options: LDElectron.LDOptions = {
        streamUrl: 'https://clientstream.eu.launchdarkly.com',
        baseUrl: 'https://clientsdk.eu.launchdarkly.com',
        eventsUrl: 'https://events.eu.launchdarkly.com'
      };

The Electron SDK uses the baseUrl for the initial connection and subsequent identify calls.If you have enabled streaming, the SDK uses the streamUrl for subsequent connections. If you have enabled useReport, these subsequent requests will use the REPORT HTTP request method. These REPORT requests are streaming requests only if you have installed the LaunchDarkly EventSource polyfill to provide streaming support. Otherwise, these requests will be standard REPORT http requests. To learn more, read EventSource under Requirements and polyfills.

Flutter

Expand Flutter code sample

To configure an alternate service endpoint for the SDK, use the ServiceEndpoints configuration option to specify the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      final config = LDConfig(
        CredentialSource.fromEnvironment(),
        autoEnvAttributes.enabled,
        serviceEndpoints: ServiceEndpoints.relayProxy('https://your-relay-proxy.com:8030')
      );

      final config = LDConfig(
        CredentialSource.fromEnvironment(),
        autoEnvAttributes.enabled,
        serviceEndpoints: ServiceEndpoints.custom(
          streaming: 'https://clientstream.launchdarkly.us',
          polling: 'https://clientsdk.launchdarkly.us',
          events: 'https://events.launchdarkly.us',
        )
      );

      final config = LDConfig(
        CredentialSource.fromEnvironment(),
        autoEnvAttributes.enabled,
        serviceEndpoints: ServiceEndpoints.custom(
          streaming: 'https://clientstream.eu.launchdarkly.com',
          polling: 'https://clientsdk.eu.launchdarkly.com',
          events: 'https://events.eu.launchdarkly.com',
        )
      );

      LDConfig ldConfig = LDConfigBuilder('example-mobile-key', AutoEnvAttributes.Enabled)
        .streamUri('https://your-relay-proxy.com:8030')
        .pollUri('https://your-relay-proxy.com:8030')
        .eventsUri('https://your-relay-proxy.com:8030')
        .build();

      LDConfig ldConfig = LDConfigBuilder('example-mobile-key', AutoEnvAttributes.Enabled)
        .streamUri('https://clientstream.launchdarkly.us')
        .pollUri('https://clientsdk.launchdarkly.us')
        .eventsUri('https://events.launchdarkly.us')
        .build();

      LDConfig ldConfig = LDConfigBuilder('example-mobile-key', AutoEnvAttributes.Enabled)
        .streamUri('https://clientstream.eu.launchdarkly.com')
        .pollUri('https://clientsdk.eu.launchdarkly.com')
        .eventsUri('https://events.eu.launchdarkly.com')
        .build();

To learn more, read serviceEndpoints.

iOS

Expand iOS code sample

To configure an alternate service endpoint for the SDK, use the streamUrl, baseUrl, and eventsUrl properties to specify the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      var ldConfig = LDConfig(mobileKey: "example-mobile-key", autoEnvAttributes: .enabled)
      ldConfig.streamUrl = URL(string: "https://your-relay-proxy.com:8030")
      ldConfig.baseUrl = URL(string: "https://your-relay-proxy.com:8030")
      ldConfig.eventsUrl = URL(string: "https://your-relay-proxy.com:8030")

      LDConfig *ldConfig = [[LDConfig alloc] initWithMobileKey:@"example-mobile-key" autoEnvAttributes:AutoEnvAttributesEnabled];
      ldConfig.streamUrl = [NSURL URLWithString:@"https://your-relay-proxy.com:8030"];
      ldConfig.baseUrl = [NSURL URLWithString:@"https://your-relay-proxy.com:8030"];
      ldConfig.eventsUrl = [NSURL URLWithString:@"https://your-relay-proxy.com:8030"];

      var ldConfig = LDConfig(mobileKey: "example-mobile-key", autoEnvAttributes: .enabled)
      ldConfig.streamUrl = URL(string: "https://clientstream.launchdarkly.us")
      ldConfig.baseUrl = URL(string: "https://clientsdk.launchdarkly.us")
      ldConfig.eventsUrl = URL(string: "https://events.launchdarkly.us")

      LDConfig *ldConfig = [[LDConfig alloc] initWithMobileKey:@"example-mobile-key" autoEnvAttributes:AutoEnvAttributesEnabled];
      ldConfig.streamUrl = [NSURL URLWithString:@"https://clientstream.launchdarkly.us"];
      ldConfig.baseUrl = [NSURL URLWithString:@"https://clientsdk.launchdarkly.us"];
      ldConfig.eventsUrl = [NSURL URLWithString:@"https://events.launchdarkly.us"];

      var ldConfig = LDConfig(mobileKey: "example-mobile-key", autoEnvAttributes: .enabled)
      ldConfig.streamUrl = URL(string: "https://clientstream.eu.launchdarkly.com")
      ldConfig.baseUrl = URL(string: "https://clientsdk.eu.launchdarkly.com")
      ldConfig.eventsUrl = URL(string: "https://events.eu.launchdarkly.com")

      LDConfig *ldConfig = [[LDConfig alloc] initWithMobileKey:@"example-mobile-key" autoEnvAttributes:AutoEnvAttributesEnabled];
      ldConfig.streamUrl = [NSURL URLWithString:@"https://clientstream.eu.launchdarkly.com"];
      ldConfig.baseUrl = [NSURL URLWithString:@"https://clientsdk.eu.launchdarkly.com"];
      ldConfig.eventsUrl = [NSURL URLWithString:@"https://events.eu.launchdarkly.com"];

If you are using LaunchDarkly iOS SDK version 9.9 or greater and you choose to enable compression of event payloads, you must upgrade Relay Proxy to version 8.9 or greater. To learn more, read enableCompression and Configuring an SDK to use the Relay Proxy.

Java

Script

Expand JavaScript code sample

To configure an alternate service endpoint for the SDK, use the streamUri, baseUri, and eventsUri properties to specify the base URIs. In previous versions of the JavaScript SDK, these properties were named streamUrl, baseUrl, and eventsUrl, respectively.Here are some examples for common base URIs that you might use instead of the defaults:

      const options = {
        streamUri: 'https://your-relay-proxy.com:8030',
        baseUri: 'https://your-relay-proxy.com:8030',
        eventsUri: 'https://your-relay-proxy.com:8030'
      };

      const options = {
        streamUrl: 'https://your-relay-proxy.com:8030',
        baseUrl: 'https://your-relay-proxy.com:8030',
        eventsUrl: 'https://your-relay-proxy.com:8030'
      };

      const options = {
        streamUri: 'https://clientstream.launchdarkly.us',
        baseUri: 'https://clientsdk.launchdarkly.us',
        eventsUri: 'https://events.launchdarkly.us'
      };

      const options = {
        streamUrl: 'https://clientstream.launchdarkly.us',
        baseUrl: 'https://clientsdk.launchdarkly.us',
        eventsUrl: 'https://events.launchdarkly.us'
      };

      const options = {
        streamUri: 'https://clientstream.eu.launchdarkly.com',
        baseUri: 'https://clientsdk.eu.launchdarkly.com',
        eventsUri: 'https://events.eu.launchdarkly.com'
      };

      const options = {
        streamUrl: 'https://clientstream.eu.launchdarkly.com',
        baseUrl: 'https://clientsdk.eu.launchdarkly.com',
        eventsUrl: 'https://events.eu.launchdarkly.com'
      };

The JavaScript SDK uses the baseUri for the initial connection and subsequent identify calls.If you have enabled streaming, the SDK uses the streamUri for subsequent connections. If you have enabled useReport, these subsequent requests will use the REPORT HTTP request method. These REPORT requests are streaming requests only if you have installed the LaunchDarkly EventSource polyfill to provide streaming support. Otherwise, these requests will be standard REPORT http requests. To learn more, read EventSource under Requirements and polyfills.

Node.js (client-side)

Expand Node.js (client-side) code sample

To configure an alternate service endpoint for the SDK, use the streamUrl, baseUrl, and eventsUrl properties to set the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      const options = {
        streamUrl: 'https://your-relay-proxy.com:8030',
        baseUrl: 'https://your-relay-proxy.com:8030',
        eventsUrl: 'https://your-relay-proxy.com:8030'
      };

      import * as ld from 'launchdarkly-node-client-sdk';

      const options: ld.LDOptions = {
        streamUrl: 'https://your-relay-proxy.com:8030',
        baseUrl: 'https://your-relay-proxy.com:8030',
        eventsUrl: 'https://your-relay-proxy.com:8030',
      };

      const options = {
        streamUrl: 'https://clientstream.launchdarkly.us',
        baseUrl: 'https://clientsdk.launchdarkly.us',
        eventsUrl: 'https://events.launchdarkly.us'
      };

      import * as ld from 'launchdarkly-node-client-sdk';

      const options: ld.LDOptions = {
        streamUrl: 'https://clientstream.launchdarkly.us',
        baseUrl: 'https://clientsdk.launchdarkly.us',
        eventsUrl: 'https://events.launchdarkly.us',
      };

      const options = {
        streamUrl: 'https://clientstream.eu.launchdarkly.com',
        baseUrl: 'https://clientsdk.eu.launchdarkly.com',
        eventsUrl: 'https://events.eu.launchdarkly.com'
      };

      import * as ld from 'launchdarkly-node-client-sdk';

      const options: ld.LDOptions = {
        streamUrl: 'https://clientstream.eu.launchdarkly.com',
        baseUrl: 'https://clientsdk.eu.launchdarkly.com',
        eventsUrl: 'https://events.eu.launchdarkly.com',
      };

The Node.js (client-side) SDK uses the baseUrl for the initial connection and subsequent identify calls.If you have enabled streaming, the SDK uses the streamUrl for subsequent connections. If you have enabled useReport, these subsequent requests will use the REPORT HTTP request method. These REPORT requests are streaming requests only if you have installed the LaunchDarkly EventSource polyfill to provide streaming support. Otherwise, these requests will be standard REPORT http requests. To learn more, read EventSource under Requirements and polyfills.

React Native

Expand React Native code sample

To configure an alternate service endpoint for the SDK, use the streamUri, baseUri, and eventsUri properties to set the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

      import { LDOptions } from '@launchdarkly/react-native-client-sdk'

      let options: LDOptions = {
        streamUri: 'https://your-relay-proxy.com:8030',
        baseUri: 'https://your-relay-proxy.com:8030',
        eventsUri: 'https://your-relay-proxy.com:8030',
      };

      import { LDOptions } from '@launchdarkly/react-native-client-sdk'

      let options: LDOptions = {
        streamUri: 'https://clientstream.launchdarkly.us',
        baseUri: 'https://clientsdk.launchdarkly.us',
        eventsUri: 'https://events.launchdarkly.us',
      };

      import { LDOptions } from '@launchdarkly/react-native-client-sdk'

      let options: LDOptions = {
        streamUri: 'https://clientstream.eu.launchdarkly.com',
        baseUri: 'https://clientsdk.eu.launchdarkly.com',
        eventsUri: 'https://events.eu.launchdarkly.com',
      };

In version 6.x and earlier, the config properties were named streamUri, pollUri, and eventsUri. They were renamed to streamUrl, pollUrl, and eventsUrl in version 7.

In version 10.0, they are named streamUri, baseUri, and eventsUri. To learn more, read LDOptions.

React Web

Expand React Web code sample

      const options = {
        baseUrl: 'https://your-relay-proxy.com:8030',
        streamUrl: 'https://your-relay-proxy.com:8030',
        eventsUrl: 'https://your-relay-proxy.com:8030'
      };

      const options = {
        baseUrl:"https://clientsdk.launchdarkly.us",
        streamUrl:"https://clientstream.launchdarkly.us",
        eventsUrl:"https://events.launchdarkly.us"
      };

      const options = {
        baseUrl:"https://clientsdk.eu.launchdarkly.com",
        streamUrl:"https://clientstream.eu.launchdarkly.com",
        eventsUrl:"https://events.eu.launchdarkly.com"
      };

The React Web SDK uses the baseUrl for the initial connection and subsequent identify calls.If you have enabled streaming, the SDK uses the streamUrl for subsequent connections. If you have enabled useReport, these subsequent requests will use the REPORT HTTP request method. These REPORT requests are streaming requests only if you have installed the LaunchDarkly EventSource polyfill to provide streaming support. Otherwise, these requests will be standard REPORT http requests. To learn more, read EventSource under Requirements and polyfills.To learn more, read Configuration options in the React Web SDK reference.

Roku

Expand Roku code sample

To configure an alternate service endpoint for the SDK, use the setStreamURI, setAppURI, and setEventsURI methods to specify the base URIs:

      ' for a legacy Roku application
      config = LaunchDarklyConfig("example-mobile-key")

      ' for a SceneGraph Roku Application
      config = LaunchDarklyConfig("example-mobile-key", CLIENT_SCENEGRAPH_NODE)

      config.setStreamURI("https://your-relay-proxy.com:8030")
      config.setAppURI("https://your-relay-proxy.com:8030")
      config.setEventsURI("https://your-relay-proxy.com:8030")

​Client-side SDKs

​.NET (client-side)

​Android

​C++ (client-side)

​Electron

​Flutter

​iOS

​Java

​Node.js (client-side)

​React Native

​React Web

​Roku

Client-side SDKs

.NET (client-side)

Android

C++ (client-side)

Electron

Flutter

iOS

Java

Node.js (client-side)

React Native

React Web

Roku