Endpoint Overrides - S2

By default, SDKs connect to the cloud instance at s2.dev, and only require an access token to get started, which can be generated from the dashboard. SDKs can also connect to any S2-compatible endpoint, such as s2-lite for local development:

TypeScript
Python
Go
Rust

const client = new S2({
	accessToken: "local-token",
	endpoints: {
		account: "http://localhost:8080",
		basin: "http://localhost:8080",
	},
});

client = S2(
    "local-token",
    endpoints=Endpoints(
        account="http://localhost:8080",
        basin="http://localhost:8080",
    ),
)

client := s2.New("local-token", &s2.ClientOptions{
	BaseURL: "http://localhost:8080",
	MakeBasinBaseURL: func(basin string) string {
		return "http://localhost:8080"
	},
})

let client = S2::new(
    S2Config::new("local-token").with_endpoints(S2Endpoints::new(
        AccountEndpoint::new("http://localhost:8080")?,
        BasinEndpoint::new("http://localhost:8080")?,
    )?),
)?;

Environment Variables

SDKs can read endpoint configuration from the environment variables below, but none of them do so automatically. Use the associated helper for reading from the environment:

TypeScript
Python
Go
Rust

// Reads S2_ACCESS_TOKEN, S2_ACCOUNT_ENDPOINT, and S2_BASIN_ENDPOINT.
const client = new S2({
	...S2Environment.parse(),
	accessToken: process.env.S2_ACCESS_TOKEN ?? "local-token",
});

# Reads S2_ACCOUNT_ENDPOINT and S2_BASIN_ENDPOINT.
client = S2(os.environ["S2_ACCESS_TOKEN"], endpoints=Endpoints.from_env())

// Reads S2_ACCESS_TOKEN, S2_ACCOUNT_ENDPOINT, and S2_BASIN_ENDPOINT.
client := s2.NewFromEnvironment(nil)

// Reads S2_ACCOUNT_ENDPOINT and S2_BASIN_ENDPOINT.
let client = S2::new(
    S2Config::new(std::env::var("S2_ACCESS_TOKEN")?)
        .with_endpoints(S2Endpoints::from_env()?),
)?;

Variable	Description
`S2_ACCOUNT_ENDPOINT`	Account-level API endpoint
`S2_BASIN_ENDPOINT`	Basin-level API endpoint (may include `{basin}` placeholder for DNS-based routing)

The CLI reads these variables automatically.