feat: update CredentialProvider mentions for api keys v2

anitarua · anitarua · commit 50d181999192 · 2026-01-15T16:34:34.000-08:00
diff --git a/docs/cache/develop/index.md b/docs/cache/develop/index.md
@@ -22,16 +22,28 @@ Here is an example of how to construct a `CacheClient`:
 
 ## Instantiating credential providers using Momento API keys
 
-You need to provide a Momento API key when instantiating a Momento client. If you don't have one yet, you can get one from the [Momento Web Console](https://console.gomomento.com/). Once you have a token, provide it to Momento SDKs when you create an instance of `CredentialProvider`. There are convenient factory methods provided to construct a `CredentialProvider` object, either from an environment variable or from a String. Below is an example of how to instantiate `CredentialProvider` from an environment variable:
+You need to provide a Momento API key when instantiating a Momento client. If you don't have one yet, you can get one from the [Momento Web Console](https://console.gomomento.com/). 
 
-<SdkExampleTabs snippetId={'API_CredentialProviderFromEnvVar'} />
+You also need to provide a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+
+Once you have an API key and an endpoint, provide it to Momento SDKs when you create an instance of `CredentialProvider`. There are convenient factory methods provided to construct a `CredentialProvider` object, either from an environment variable or from a String. Below is an example of how to instantiate `CredentialProvider` from the default environment variables `MOMENTO_API_KEY` and `MOMENTO_ENDPOINT`:
+
+<SdkExampleTabs snippetId={'API_CredentialProviderFromEnvVarV2Default'} />
+
+Alternately provide custom environment variable names:
+
+<SdkExampleTabs snippetId={'API_CredentialProviderFromEnvVarV2'} />
 
 If you're storing your Momento auth token in a secret manager such as [AWS Secret Manager](https://aws.amazon.com/secrets-manager/), [GCP Secret Manager](https://cloud.google.com/secret-manager), or a local config file, you must first retrieve the credentials from there and then instantiate a `CredentialProvider` from a string, like this:
 
-<SdkExampleTabs snippetId={'API_CredentialProviderFromString'} />
+<SdkExampleTabs snippetId={'API_CredentialProviderFromApiKeyV2'} />
 
 For an example of how to retrieve credentials from AWS Secrets Manager, see [Retrieving a Momento auth token from AWS Secrets Manager](/cache/integrations/aws-secrets-manager).
 
+If you have a disposable auth token or a v1 API key, you can instantiate a `CredentialProvider` like this:
+
+<SdkExampleTabs snippetId={'API_CredentialProviderFromDisposableToken'} />
+
 For general information on Momento authentication, see [our auth page](../authentication/index.mdx).
 
 For more information, see our [Response Objects](./develop/api-reference/response-objects) page, and the docs for the specific SDK that you are using (under `Develop`->`SDKs` in the left nav).
diff --git a/docs/leaderboards/index.md b/docs/leaderboards/index.md
@@ -52,9 +52,6 @@ Then follow our [step-by-step instructions](https://docs.momentohq.com/cache/aut
 // as many leaderboards as you wish
 const client = new PreviewLeaderboardClient({
   configuration: LeaderboardConfigurations.Laptop.v1(),
-  credentialProvider: CredentialProvider.fromEnvironmentVariable({
-    environmentVariableName: 'MOMENTO_API_KEY',
-  }),
 });
 
 // Create a new leaderboard with the given cache and leaderboard name
diff --git a/docs/platform/index.mdx b/docs/platform/index.mdx
@@ -19,7 +19,7 @@ keywords:
 
 # The Momento Platform
 
-Ship better products, faster with a platform designed for mission-critical workloads. Momento makes infrastructure easy at enterprise scale with [caching](/cache), [unrivaled event messaging](/topics), and soon, *storage*!
+Ship better products, faster with a platform designed for mission-critical workloads. Momento makes infrastructure easy at enterprise scale with [caching](/cache) and [unrivaled event messaging](/topics)!
 
 import { CardGrid } from '@site/src/components/CardGrid';
 import { LinkCard } from '@site/src/components/LinkCard';
diff --git a/docs/platform/sdks/dart/cache.mdx b/docs/platform/sdks/dart/cache.mdx
@@ -64,6 +64,15 @@ export MOMENTO_API_KEY=<your api key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Set up a CacheClient
 This code creates the CacheClient that you will use to call the other methods.
 
diff --git a/docs/platform/sdks/dart/index.md b/docs/platform/sdks/dart/index.md
@@ -43,6 +43,7 @@ Dart packages are published to [pub.dev as `momento`](https://pub.dev/packages/m
 
 - [Dart version 3](https://dart.dev/get-dart) or higher is required.
 - A Momento API key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 
 ## Resources
 
diff --git a/docs/platform/sdks/dart/topics.mdx b/docs/platform/sdks/dart/topics.mdx
@@ -65,6 +65,15 @@ export MOMENTO_API_KEY=<your api key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Set up a TopicClient
 This code creates the TopicClient that you will use to interact with your pub/sub topic.
 
diff --git a/docs/platform/sdks/dotnet/cache.mdx b/docs/platform/sdks/dotnet/cache.mdx
@@ -55,6 +55,15 @@ export MOMENTO_API_KEY=<your Momento API key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Set up your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Import libraries and create a CacheClient object
 [This example file](https://github.com/momentohq/client-sdk-dotnet/blob/main/examples/MomentoUsage/Program.cs) pulls in the necessary imports, reads the API key from an environment variable, and instantiates the CacheClient that is used to interact with a cache.
 
diff --git a/docs/platform/sdks/dotnet/index.md b/docs/platform/sdks/dotnet/index.md
@@ -39,6 +39,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-dotnet](https://gi
 
 - [`dotnet` runtime and command line tools](https://dotnet.microsoft.com/en-us/download); after installing them, you should have the `dotnet` command on your PATH.
 - A Momento API Key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 - You will most likely want an IDE that supports .NET development, such as [Microsoft Visual Studio](https://visualstudio.microsoft.com/vs), [JetBrains Rider](https://www.jetbrains.com/rider/), or [Microsoft Visual Studio Code](https://code.visualstudio.com/).
 
 ## Resources
diff --git a/docs/platform/sdks/dotnet/topics.mdx b/docs/platform/sdks/dotnet/topics.mdx
@@ -55,6 +55,15 @@ export MOMENTO_API_KEY=<your api key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Set up a TopicClient
 This code creates the TopicClient that you will use to interact with your pub/sub topic.
 
diff --git a/docs/platform/sdks/elixir/cache.mdx b/docs/platform/sdks/elixir/cache.mdx
@@ -49,6 +49,15 @@ Once you have your token, store it in an environment variable so that the Moment
 export MOMENTO_API_KEY=<your Momento token here>
 ```
 
+## Set up your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Set up a CacheClient
 This code creates the CacheClient struct that each of the other functions requires.
 
diff --git a/docs/platform/sdks/elixir/index.md b/docs/platform/sdks/elixir/index.md
@@ -39,6 +39,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-elixir](https://gi
 
 - [Elixir version 1.14](https://elixir-lang.org/install.html) or higher is required.
 - A Momento API Key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 
 ## Resources
 
diff --git a/docs/platform/sdks/go/cache.mdx b/docs/platform/sdks/go/cache.mdx
@@ -52,6 +52,15 @@ export MOMENTO_API_KEY=<your Momento token here>
 
 **Note**: it is best practice to put the token into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Set up your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Import libraries and create a CacheClient object
 First, pull in the necessary imports and set up the main function.
 
diff --git a/docs/platform/sdks/go/index.md b/docs/platform/sdks/go/index.md
@@ -43,6 +43,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-go](https://github
 
 - [Go](https://go.dev/dl/)
 - A Momento API key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 
 ## Resources
 
diff --git a/docs/platform/sdks/go/topics.mdx b/docs/platform/sdks/go/topics.mdx
@@ -52,6 +52,15 @@ export MOMENTO_API_KEY=<your api key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Set up a TopicClient
 This code creates the TopicClient that you will use to interact with your pub/sub topic.
 
diff --git a/docs/platform/sdks/java/cache.mdx b/docs/platform/sdks/java/cache.mdx
@@ -69,6 +69,15 @@ Once you have your token, store it in an environment variable so that the Moment
 export MOMENTO_API_KEY=<your Momento API key here>
 ```
 
+## Set up your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Import libraries and connect to return a CacheClient object
 This code sets up the main function, the necessary imports,  and the CacheClient instantiation that each of the other functions will need to call.
 
diff --git a/docs/platform/sdks/java/index.md b/docs/platform/sdks/java/index.md
@@ -36,6 +36,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-java](https://gith
 ## Requirements
 
 - A Momento API Key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 - At least the java 8 run time installed
 - mvn or gradle for downloading the sdk
 
diff --git a/docs/platform/sdks/java/topics.mdx b/docs/platform/sdks/java/topics.mdx
@@ -72,6 +72,15 @@ export MOMENTO_API_KEY=<your api key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Set up a TopicClient
 This code creates the TopicClient that you will use to interact with your pub/sub topic.
 
diff --git a/docs/platform/sdks/kotlin/cache.mdx b/docs/platform/sdks/kotlin/cache.mdx
@@ -72,6 +72,15 @@ Once you have your API key, store it in an environment variable so that the Mome
 export MOMENTO_API_KEY=<your Momento API key here>
 ```
 
+## Set up your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Import libraries and instantiate a CacheClient object
 
 This code sets up the main function, the necessary imports, and the CacheClient instantiation that each of the other functions will need to call.
diff --git a/docs/platform/sdks/kotlin/index.md b/docs/platform/sdks/kotlin/index.md
@@ -38,6 +38,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-kotlin](https://gi
 ## Requirements
 
 - A Momento API Key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 - At least the Java 11 run time installed, or Android 23+.
 - mvn or gradle for downloading the sdk.
 
diff --git a/docs/platform/sdks/kotlin/topics.mdx b/docs/platform/sdks/kotlin/topics.mdx
@@ -74,6 +74,15 @@ export MOMENTO_API_KEY=<your api key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Set up a TopicClient
 This code creates the TopicClient that you will use to interact with your pub/sub topic.
 
diff --git a/docs/platform/sdks/nodejs/cache.mdx b/docs/platform/sdks/nodejs/cache.mdx
@@ -68,6 +68,15 @@ export MOMENTO_API_KEY=<your Momento API key here>
 
 **Note**: it is best practice to put the API key into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Import libraries and create a CacheClient object
 This code sets up the main function, pulls in the necessary imports, and instantiates the CacheClient that will be used to interact with your cache.
 
diff --git a/docs/platform/sdks/nodejs/index.md b/docs/platform/sdks/nodejs/index.md
@@ -43,6 +43,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-javascript](https:
 
 - Node version [16 or higher](https://nodejs.org/en/download/) is required.
 - A Momento API Key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 
 ## Resources
 
diff --git a/docs/platform/sdks/nodejs/topics.mdx b/docs/platform/sdks/nodejs/topics.mdx
@@ -68,6 +68,15 @@ export MOMENTO_API_KEY=<your Momento token here>
 
 **Note**: it is best practice to put the token into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Get your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Import libraries and create a TopicClient object
 This code sets up the main function, pulls in the necessary imports, and instantiates the TopicClient that will be used to interact with your pub/sub topic.
 
diff --git a/docs/platform/sdks/php/cache.mdx b/docs/platform/sdks/php/cache.mdx
@@ -37,6 +37,7 @@ For more info, you can also see [the PHP SDK on GitHub](https://github.com/momen
 ### Prerequisites
 
 * A Momento API Key is required. You can generate one using [the Momento console](https://console.gomomento.com/).
+* A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 * Installation of PHP 8.0 or higher
 * Installation of the [gRPC PHP extension](https://github.com/grpc/grpc/blob/master/src/php/README.md).
 * Installation of the [protobuf C extension](https://developers.google.com/google-ads/api/docs/client-libs/php/protobuf#c_implementation)
@@ -78,7 +79,7 @@ $KEY = "MyKey";
 $VALUE = "MyValue";
 
 // Setup
-$authProvider = CredentialProvider::fromEnvironmentVariable("MOMENTO_API_KEY");
+$authProvider = CredentialProvider::fromEnvironmentVariablesV2("MOMENTO_API_KEY", "MOMENTO_ENDPOINT");
 $configuration = Laptop::latest(new StderrLoggerFactory());
 $client = new CacheClient($configuration, $authProvider, $ITEM_DEFAULT_TTL_SECONDS);
 $logger = $configuration->getLoggerFactory()->getLogger("ex:");
diff --git a/docs/platform/sdks/php/index.mdx b/docs/platform/sdks/php/index.mdx
@@ -42,6 +42,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-php](https://githu
 ## Requirements
 
 - A Momento API key is required; you can get one from the [Momento web console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 - At least PHP 8.0
 - The grpc PHP extension. See the [gRPC docs](https://github.com/grpc/grpc/blob/master/src/php/README.md) section on installing the extension.
 - The protobuf C extension. See the [protobuf C extension docs](https://developers.google.com/google-ads/api/docs/client-libs/php/protobuf#c_implementation) for installation instructions.
diff --git a/docs/platform/sdks/python/cache.md b/docs/platform/sdks/python/cache.md
@@ -58,6 +58,15 @@ export MOMENTO_API_KEY=<your Momento token here>
 
 **Note**: it is best practice to put the token into something like AWS Secret Manager or GCP Secret Manager instead of an environment variable for enhanced security, but we are using one here for demo purposes.
 
+## Set up your Momento service endpoint
+
+You'll also need a Momento service endpoint. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
+Once you have selected an endpoint, store it in an environment variable so that the Momento client can consume it:
+
+```
+export MOMENTO_ENDPOINT=<your service endpoint here>
+```
+
 ## Import libraries and connect to return a CacheClient object
 
 This code sets up the class with the necessary imports, the class definition, and the CacheClient instantiation that each of the other functions will need to call.
diff --git a/docs/platform/sdks/python/index.md b/docs/platform/sdks/python/index.md
@@ -37,6 +37,7 @@ The source code can be found on GitHub: [momentohq/client-sdk-python](https://gi
 
 - [Python 3.7](https://www.python.org/downloads/) or above is required
 - A Momento API Key is required; you can get one from the [Momento Web Console](https://console.gomomento.com/).
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions).
 
 ## Resources
 
diff --git a/docs/platform/sdks/python/topics.mdx b/docs/platform/sdks/python/topics.mdx
diff --git a/docs/platform/sdks/ruby/index.md b/docs/platform/sdks/ruby/index.md
diff --git a/docs/platform/sdks/rust/cache.mdx b/docs/platform/sdks/rust/cache.mdx
diff --git a/docs/platform/sdks/rust/config-and-error-handling.mdx b/docs/platform/sdks/rust/config-and-error-handling.mdx
diff --git a/docs/platform/sdks/rust/index.md b/docs/platform/sdks/rust/index.md
diff --git a/docs/platform/sdks/rust/topics.mdx b/docs/platform/sdks/rust/topics.mdx
diff --git a/docs/platform/sdks/swift/cache.mdx b/docs/platform/sdks/swift/cache.mdx
diff --git a/docs/platform/sdks/swift/index.md b/docs/platform/sdks/swift/index.md
diff --git a/docs/platform/sdks/swift/topics.mdx b/docs/platform/sdks/swift/topics.mdx
diff --git a/docs/platform/sdks/unity/index.md b/docs/platform/sdks/unity/index.md
diff --git a/docs/platform/sdks/web/index.md b/docs/platform/sdks/web/index.md
diff --git a/docs/topics/develop/index.md b/docs/topics/develop/index.md
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
