Service endpoint configuration

Read time: 3 minutes

Last edited: Jan 05, 2023

Overview

This topic explains how to configure LaunchDarkly SDKs to connect to alternate service endpoints. Typically this is only required for customers working with the LaunchDarkly federal instance.

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.

Each SDK is configured by default to connect these services. Most customers do not need to configure service endpoints.

Newer versions of LaunchDarkly SDKs replace users with contexts

A context is a generalized way of referring to the people, services, machines, or other resources that encounter feature flags in your product. To learn more, read Contexts.

Creating contexts and evaluating flags based on them is supported in the latest major versions of some of our SDKs. For these SDKs, the code samples on this page include the two most recent versions.

You can upgrade your SDKs at any time, but the ability to target by context, or review context instances that have encountered flags in your application, is only available for customers in the contexts Early Access Program (EAP). If you want access to this feature, join the EAP.

If you are using the latest version of an SDK and are not part of the EAP, your application can send contexts to LaunchDarkly and they will appear on the Users list.

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.

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 Configuration.

The example code uses endpoint values specific to the LaunchDarkly federal instance

You can use the methods and options described on this page to configure any alternate service endpoints.

The code samples all use URIs from the federal instance of LaunchDarkly, because working with a federal instance is the most common use case for setting alternate service endpoints.

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/C++ (client-side)
Electron
Flutter
iOS
JavaScript
Node.js (client-side)
React Native
React Web

.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:

var config = Configuration.Builder("mobile-key-123abc")
    .ServiceEndpoints(Components.ServiceEndpoints()
      .Streaming("https://clientstream.launchdarkly.us")
      .Polling("https://clientsdk.launchdarkly.us")
      .Events("https://events.launchdarkly.us"))
    .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:

LDConfig ldConfig = new LDConfig.Builder()
  .mobileKey("mobile-key-123abc")
  .streamUri(Uri.parse("https://clientstream.launchdarkly.us"))
  .pollUri(Uri.parse("https://clientsdk.launchdarkly.us"))
  .eventsUri(Uri.parse("https://events.launchdarkly.us"))
  .build();

C/C++ (client-side)

Expand C/C++ (client-side) code sample

To configure an alternate service endpoint for the SDK, use LDConfigSetStreamURI, LDConfigSetAppURI, and LDConfigSetEventsURI to specify the base URIs:

struct LDConfig *config = LDConfigNew("mobile-key-123abc");
LDConfigSetStreamURI(config, "https://clientstream.launchdarkly.us");
LDConfigSetAppURI(config, "https://app.launchdarkly.us");
LDConfigSetEventsURI(config, "https://events.launchdarkly.us");

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:

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

Flutter

Expand Flutter code sample

To configure an alternate service endpoint for the SDK, use the streamUri, pollUri, and eventsUri builder methods to specify the base URIs:

LDConfig ldConfig = LDConfigBuilder("mobile-key-123abc")
  .streamUri("https://clientstream.launchdarkly.us")
  .pollUri("https://clientsdk.launchdarkly.us")
  .eventsUri("https://events.launchdarkly.us")
  .build();

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:

var ldConfig = LDConfig(mobileKey: "mobile-key-123abc")
ldConfig.streamUrl = URL(string: "https://clientstream.launchdarkly.us")
ldConfig.baseUrl = URL(string: "https://app.launchdarkly.us")
ldConfig.eventsUrl = URL(string: "https://events.launchdarkly.us")

JavaScript

Expand JavaScript code sample

To configure an alternate service endpoint for the SDK, use the streamUrl, baseUrl, and eventsUrl properties to specify the base URIs:

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

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:

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

React Native

Expand React Native code sample

To configure an alternate service endpoint for the SDK, use the streamUri, pollUri, and eventsUri properties to set the base URIs:

let config = {
  mobileKey: 'mobile-key-123abc',
  streamUri: 'https://clientstream.launchdarkly.us',
  pollUri: 'https://clientsdk.launchdarkly.us',
  eventsUri: 'https://events.launchdarkly.us',
};

React Web

Expand React code sample

To configure an alternate service endpoint for the SDK, use the streamUrl, baseUrl, and eventsUrl options to specify the base URIs:

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

To learn more, read Configuring the React SDK.

Server-side SDKs

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

.NET (server-side)
Apex
C/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

To configure an alternate service endpoint for the SDK, use the ServiceEndpoints builder method to specify the base URIs:

var config = Configuration.Builder("sdk-key-123abc")
    .ServiceEndpoints(Components.ServiceEndpoints()
      .Streaming("https://stream.launchdarkly.us")
      .Polling("https://sdk.launchdarkly.us")
      .Events("https://events.launchdarkly.us"))
    .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 Using 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

C/C++ (server-side)

Expand C/C++ (server-side) code sample

To configure an alternate service endpoint for the SDK, use LDConfigSetStreamURI, LDConfigSetBaseURI, and LDConfigSetEventsURI to specify the base URIs:

struct LDConfig *config = LDConfigNew("sdk-key-123abc");
LDConfigSetStreamURI(config, "https://stream.launchdarkly.us");
LDConfigSetBaseURI(config, "https://app.launchdarkly.us");
LDConfigSetEventsURI(config, "https://events.launchdarkly.us");

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:

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

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:

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

Haskell

Expand Haskell code sample

To configure an alternate service endpoint for the SDK, use configSetStreamURI, configSetBaseURI, and configSetEventsURI to specify the base URIs:

{-# LANGUAGE OverloadedStrings #-}
import LaunchDarkly.Server.Config
import Data.Function ((&))
config :: Config
config = (makeConfig "sdk-key-123abc")
    & configSetStreamURI "https://stream.launchdarkly.us"
    & configSetBaseURI "https://app.launchdarkly.us"
    & configSetEventsURI "https://events.launchdarkly.us"

Java

Expand Java code sample

To configure an alternate service endpoint for the SDK, use the serviceEndpoints builder method to specify the base URIs:

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

Lua

Expand Lua code sample

To configure an alternate service endpoint for the SDK, use the streamURI, baseURI, and eventsURI properties to specify the base URIs:

local config = {
    key = sdk-key-123abc,
    streamURI = "https://stream.launchdarkly.us",
    baseUri = "https://app.launchdarkly.us",
    eventsURI = "https://events.launchdarkly.us",
}

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:

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

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:

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

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:

config = Config(sdk_key='sdk-key-123abc',
  stream_uri="https://stream.launchdarkly.us",
  base_uri="https://app.launchdarkly.us",
  events_uri="https://events.launchdarkly.us")

Ruby

Expand Ruby code sample