Service endpoint configuration

This topic explains how to configure LaunchDarkly SDKs to connect to alternate service endpoints. Each SDK connects to several LaunchDarkly web services. These include services for getting feature flag data using streaming or polling, and a service for storing analytics events. Optionally, you can configure LaunchDarkly to connect to alternate service endpoints. Most customers do not need to configure service endpoints. You may need to configure service endpoints in the following situations:

You are working with the LaunchDarkly federal instance. If you are using the federal instance of LaunchDarkly, you must configure the SDK so that it connects to the federal instance for these services instead.
You are working with the LaunchDarkly European Union (EU) instance. If you are using the EU instance of LaunchDarkly, you must configure the SDK so that it connects to the federal instance for these services instead. To learn which URLs to use instead, read the EU instance documentation.
You are using the Relay Proxy in proxy mode. To learn more, read Using proxy mode.
You are using the LaunchDarkly CLI to run a local dev-server for testing, and you want to access local flag values from there. To learn more, read Using the LaunchDarkly CLI for local testing.

The examples below show how to configure the SDK for each service. In most SDKs, you then need to pass the configuration in as a parameter when you initialize the client. To learn more, read SDK configuration. Details about each SDK’s configuration are available in the SDK-specific sections below:

Client-side SDKs
Server-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
Vue

.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',
  )
);

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"];

Relay Proxy compatibility with event payload compressionIf 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.

JavaScript

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.0. 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")

Vue

Expand Vue 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"
};

Server-side SDKs

This feature is available for the following server-side SDKs:

.NET (server-side)
Apex
C++ (server-side)
Erlang
Go
Haskell
Java
Lua
Node.js (server-side)
PHP
Python
Ruby
Rust

.NET (server-side)

Expand .NET (server-side) code sample

var config = Configuration.Builder("YOUR_SDK_KEY")
    .ServiceEndpoints(Components.ServiceEndpoints()
      .RelayProxy("https://your-relay-proxy.com:8030"))
    .Build();

var config = Configuration.Builder("YOUR_SDK_KEY")
    .ServiceEndpoints(Components.ServiceEndpoints()
      .Streaming("https://stream.launchdarkly.us")
      .Polling("https://sdk.launchdarkly.us")
      .Events("https://events.launchdarkly.us"))
    .Build();

var config = Configuration.Builder("YOUR_SDK_KEY")
    .ServiceEndpoints(Components.ServiceEndpoints()
      .Streaming("https://stream.eu.launchdarkly.com")
      .Polling("https://sdk.eu.launchdarkly.com")
      .Events("https://events.eu.launchdarkly.com"))
    .Build();

Apex

Expand Apex code sample

First, set up the Apex bridge. If you are a federal customer, make sure you run the Apex bridge within your own FedRAMP-compliant environment. To learn more, read Use the LaunchDarkly Salesforce bridge.To configure an alternate service endpoint for the SDK, export the alternate URIs before you build the bridge:

cd bridge && go build .

# other required export statements...

export LD_BASE_URI='https://sdk.launchdarkly.us'
export LD_EVENTS_URL='https://events.launchdarkly.us'

./bridge

cd bridge && go build .

# other required export statements...

export LD_BASE_URI='https://sdk.eu.launchdarkly.com'
export LD_EVENTS_URL='https://events.eu.launchdarkly.com'

./bridge

C++ (server-side)

Expand C++ (server-side) code sample

auto config_builder = server_side::ConfigBuilder("YOUR_SDK_KEY");
config_builder.ServiceEndpoints()
    .RelayProxyBaseURL("https://your-relay-proxy.com:8030");
auto config = config_builder.Build();
if (!config) {
    /* an error occurred, config is not valid */
}

LDServerConfigBuilder builder = LDServerConfigBuilder_New("YOUR_SDK_KEY");

LDServerConfigBuilder_ServiceEndpoints_RelayProxyBaseURL(builder, "https://your-relay-proxy.com:8030");

LDServerConfig config;
LDStatus status = LDServerConfigBuilder_Build(builder, &config);
if (!LDStatus_Ok(status)) {
    /* an error occurred, config is not valid */
}

auto config_builder = server_side::ConfigBuilder("YOUR_SDK_KEY");
config_builder.ServiceEndpoints()
    .StreamingBaseUrl("https://stream.launchdarkly.us")
    .PollingBaseUrl("https://sdk.launchdarkly.us")
    .EventsBaseUrl("https://events.launchdarkly.us");
auto config = config_builder.Build();
if (!config) {
    /* an error occurred, config is not valid */
}

LDServerConfigBuilder builder = LDServerConfigBuilder_New("YOUR_SDK_KEY");
LDServerConfigBuilder_ServiceEndpoints_StreamingBaseURL(builder, "https://stream.launchdarkly.us");
LDServerConfigBuilder_ServiceEndpoints_PollingBaseURL(builder, "https://sdk.launchdarkly.us");
LDServerConfigBuilder_ServiceEndpoints_EventsBaseURL(builder, "https://events.launchdarkly.us");
LDServerConfig config;

LDStatus status = LDServerConfigBuilder_Build(builder, &config);

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

auto config_builder = server_side::ConfigBuilder("YOUR_SDK_KEY");
config_builder.ServiceEndpoints()
    .StreamingBaseUrl("https://stream.eu.launchdarkly.com")
    .PollingBaseUrl("https://sdk.eu.launchdarkly.com")
    .EventsBaseUrl("https://events.eu.launchdarkly.com");
auto config = config_builder.Build();
if (!config) {
    /* an error occurred, config is not valid */
}

LDServerConfigBuilder builder = LDServerConfigBuilder_New("YOUR_SDK_KEY");
LDServerConfigBuilder_ServiceEndpoints_StreamingBaseURL(builder, "https://stream.eu.launchdarkly.com");
LDServerConfigBuilder_ServiceEndpoints_PollingBaseURL(builder, "https://sdk.eu.launchdarkly.com");
LDServerConfigBuilder_ServiceEndpoints_EventsBaseURL(builder, "https://events.eu.launchdarkly.com");
LDServerConfig config;

LDStatus status = LDServerConfigBuilder_Build(builder, &config);

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

To learn more, read ServiceEndpoints() in ConfigBuilder.

Erlang

Expand Erlang code sample

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

ldclient:start_instance("YOUR_SDK_KEY", #{
  stream_uri => "https://your-relay-proxy.com:8030",
  base_uri => "https://your-relay-proxy.com:8030",
  events_uri => "https://your-relay-proxy.com:8030"
})

ldclient:start_instance("YOUR_SDK_KEY", #{
  stream_uri => "https://stream.launchdarkly.us",
  base_uri => "https://sdk.launchdarkly.us",
  events_uri => "https://events.launchdarkly.us"
})

ldclient:start_instance("YOUR_SDK_KEY", #{
  stream_uri => "https://stream.eu.launchdarkly.com",
  base_uri => "https://sdk.eu.launchdarkly.com",
  events_uri => "https://events.eu.launchdarkly.com"
})

Go

Expand Go code sample

To configure an alternate service endpoint for the SDK, use the Config.ServiceEndpoints property and interfaces.ServiceEndpoints() to specify the base URIs. Here are some examples for common base URIs that you might use instead of the defaults:

// To use the Replay Proxy in proxy mode for both streaming and events:

config := ld.Config{
    ServiceEndpoints: ldcomponents.RelayProxyEndpoints(
      "https://your-relay-proxy.com:8030"),
}

// Alternatively, to use the Relay Proxy in proxy mode for streaming,
// but send events directly to LaunchDarkly, use:
config := ld.Config{
    ServiceEndpoints: ldcomponents.RelayProxyEndpointsWithoutEvents(
        "https://your-relay-proxy.com:8030"),
}

config := ld.Config{
    ServiceEndpoints: interfaces.ServiceEndpoints{
      Streaming: "https://stream.launchdarkly.us",
      Polling: "https://sdk.launchdarkly.us",
      Events: "https://events.launchdarkly.us",
    },
}

config := ld.Config{
    ServiceEndpoints: interfaces.ServiceEndpoints{
      Streaming: "https://stream.eu.launchdarkly.com",
      Polling: "https://sdk.eu.launchdarkly.com",
      Events: "https://events.eu.launchdarkly.com",
    },
}

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Go SDK version 7.6 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 EnableGzip and Configuring an SDK to use the Relay Proxy.

Haskell

Expand Haskell code sample

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

{-# LANGUAGE OverloadedStrings #-}

import LaunchDarkly.Server.Config

import Data.Function ((&))

config :: Config
config = (makeConfig "YOUR_SDK_KEY")
    & configSetStreamURI "https://your-relay-proxy.com:8030"
    & configSetBaseURI "https://your-relay-proxy.com:8030"
    & configSetEventsURI "https://your-relay-proxy.com:8030"

{-# LANGUAGE OverloadedStrings #-}

import LaunchDarkly.Server.Config

import Data.Function ((&))

config :: Config
config = (makeConfig "YOUR_SDK_KEY")
    & configSetStreamURI "https://stream.launchdarkly.us"
    & configSetBaseURI "https://sdk.launchdarkly.us"
    & configSetEventsURI "https://events.launchdarkly.us"

{-# LANGUAGE OverloadedStrings #-}

import LaunchDarkly.Server.Config

import Data.Function ((&))

config :: Config
config = (makeConfig "YOUR_SDK_KEY")
    & configSetStreamURI "https://stream.eu.launchdarkly.com"
    & configSetBaseURI "https://sdk.eu.launchdarkly.com"
    & configSetEventsURI "https://events.eu.launchdarkly.com"

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Haskell SDK version 4.4 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 configSetCompressEvents and Configuring an SDK to use the Relay Proxy.

Java

Expand Java 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:

LDConfig config = new LDConfig.Builder()
  .serviceEndpoints(Components.serviceEndpoints()
    .relayProxy("https://your-relay-proxy.com:8030"))
  .build();

LDConfig config = new LDConfig.Builder()
  .serviceEndpoints(Components.serviceEndpoints()
    .streaming("https://stream.launchdarkly.us")
    .polling("https://sdk.launchdarkly.us")
    .events("https://events.launchdarkly.us"))
  .build();

LDConfig config = new LDConfig.Builder()
  .serviceEndpoints(Components.serviceEndpoints()
    .streaming("https://stream.eu.launchdarkly.com")
    .polling("https://sdk.eu.launchdarkly.com")
    .events("https://events.eu.launchdarkly.com"))
  .build();

Lua

Expand Lua code sample

To configure an alternate service endpoint for the SDK, use the serviceEndpoints property to specify the base URLs. Here are some examples for common base URLs that you might use instead of the defaults:

local config = {
    serviceEndpoints = {
      streamingBaseURL = "https://your-relay-proxy.com:8030",
      pollingBaseURL = "https://your-relay-proxy.com:8030",
      eventsBaseURL = "https://your-relay-proxy.com:8030"
    }
}

local config = {
    serviceEndpoints = {
      streamingBaseURL = "https://stream.launchdarkly.us",
      pollingBaseURL = "https://sdk.launchdarkly.us",
      eventsBaseURL = "https://events.launchdarkly.us"
    }
}

local config = {
    serviceEndpoints = {
      streamingBaseURL = "https://stream.eu.launchdarkly.com",
      pollingBaseURL = "https://sdk.eu.launchdarkly.com",
      eventsBaseURL = "https://events.eu.launchdarkly.com"
    }
}

To learn more about the configuration options, read clientInit.

Node.js (server-side)

Expand Node.js (server-side) code sample

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

import { LDOptions } from '@launchdarkly/node-server-sdk';

const 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/node-server-sdk';

const options: LDOptions = {
  streamUri: 'https://stream.launchdarkly.us',
  baseUri: 'https://sdk.launchdarkly.us',
  eventsUri: 'https://events.launchdarkly.us',
};

import { LDOptions } from '@launchdarkly/node-server-sdk';

const options: LDOptions = {
  streamUri: 'https://stream.eu.launchdarkly.com',
  baseUri: 'https://sdk.eu.launchdarkly.com',
  eventsUri: 'https://events.eu.launchdarkly.com',
};

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Node.js (server-side) SDK version 9.8 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 enableEventCompression and Configuring an SDK to use the Relay Proxy.

PHP

Expand PHP code sample

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

$client = new LaunchDarkly\LDClient("YOUR_SDK_KEY",
    [ "base_uri" => "https://your-relay-proxy.com:8030",
      "events_uri" => "https://your-relay-proxy.com:8030" ]);

$client = new LaunchDarkly\LDClient("YOUR_SDK_KEY",
    [ "base_uri" => "https://sdk.launchdarkly.us",
      "events_uri" => "https://events.launchdarkly.us" ]);

$client = new LaunchDarkly\LDClient("YOUR_SDK_KEY",
    [ "base_uri" => "https://sdk.eu.launchdarkly.com",
      "events_uri" => "https://events.eu.launchdarkly.com" ]);

There is not a streaming service for the PHP SDK.

Python

Expand Python code sample

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

config = Config(sdk_key='YOUR_SDK_KEY',
  stream_uri="https://your-relay-proxy.com:8030",
  base_uri="https://your-relay-proxy.com:8030",
  events_uri="https://your-relay-proxy.com:8030")

config = Config(sdk_key='YOUR_SDK_KEY',
  stream_uri="https://stream.launchdarkly.us",
  base_uri="https://sdk.launchdarkly.us",
  events_uri="https://events.launchdarkly.us")

config = Config(sdk_key='YOUR_SDK_KEY',
  stream_uri="https://stream.eu.launchdarkly.com",
  base_uri="https://sdk.eu.launchdarkly.com",
  events_uri="https://events.eu.launchdarkly.com")

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Python SDK version 9.5 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, set enable_event_compression in the ldclient.config module and read Configuring an SDK to use the Relay Proxy.

Ruby

Expand Ruby code sample

config = LaunchDarkly::Config.new(
  stream_uri: "https://your-relay-proxy.com:8030",
  base_uri: "https://your-relay-proxy.com:8030",
  events_uri: "https://your-relay-proxy.com:8030")

config = LaunchDarkly::Config.new(
  stream_uri: "https://stream.launchdarkly.us",
  base_uri: "https://sdk.launchdarkly.us",
  events_uri: "https://events.launchdarkly.us")

config = LaunchDarkly::Config.new(
  stream_uri: "https://stream.eu.launchdarkly.com",
  base_uri: "https://sdk.eu.launchdarkly.com",
  events_uri: "https://events.eu.launchdarkly.com")

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Ruby SDK version 8.7 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 compress_events and Configuring an SDK to use the Relay Proxy.

Rust

Expand Rust code sample

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

let config = ConfigBuilder::new("YOUR_SDK_KEY")
    .service_endpoints(
        ServiceEndpointsBuilder::new().relay_proxy("https://your-relay-proxy.com:8030"),
    )
    .build()
    .unwrap();

let config = ConfigBuilder::new("YOUR_SDK_KEY").service_endpoints(ServiceEndpointsBuilder::new()
  .streaming_base_url("https://stream.launchdarkly.us")
  .polling_base_url("https://sdk.launchdarkly.us")
  .events_base_url("https://events.launchdarkly.us"))
  .build()
  .unwrap();

let config = ConfigBuilder::new("YOUR_SDK_KEY").service_endpoints(ServiceEndpointsBuilder::new()
  .streaming_base_url("https://stream.eu.launchdarkly.com")
  .polling_base_url("https://sdk.eu.launchdarkly.com")
  .events_base_url("https://events.eu.launchdarkly.com"))
  .build()
  .unwrap();

Relay Proxy compatibility with event payload compressionIf you are using LaunchDarkly Rust SDK version 2.4 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 compress_events and Configuring an SDK to use the Relay Proxy.

​Client-side SDKs

​.NET (client-side)

​Android

​C++ (client-side)

​Electron

​Flutter

​iOS

​JavaScript

​Node.js (client-side)

​React Native

​React Web

​Roku

​Vue

​Server-side SDKs

​.NET (server-side)

​Apex

​C++ (server-side)

​Erlang

​Go

​Haskell

​Java

​Lua

​Node.js (server-side)

​PHP

​Python

​Ruby

​Rust

Client-side SDKs

.NET (client-side)

Android

C++ (client-side)

Electron

Flutter

iOS

JavaScript

Node.js (client-side)

React Native

React Web

Roku

Vue

Server-side SDKs

.NET (server-side)

Apex

C++ (server-side)

Erlang

Go

Haskell

Java

Lua

Node.js (server-side)

PHP

Python

Ruby

Rust