Endpoints

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. Users who elect to use Private Networking can provide the relevant endpoints as an override when configuring the client. 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 some common configuration keys from environment variables:

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

SDKs

Documentation Index

​Environment Variables

Environment Variables