Farther ShoreDocs
Go to Farther Shore
Getting startedCore conceptsLaunch checklist
ProductsUpstream routingEnvironmentsDeveloper portals
Billing strategiesPlans and limitsSubscribersAPI keys
Gateway enforcementUsage meteringLimits and creditsGateway sharding
Launch a request-counted product15mAdd monthly included usageAdd subscription plus overageCreate a prepaid credits productMeter AI token usageAdd a custom meterIssue and test an API keyDebug a denied requestUpdate product docsPrepare for launch
TroubleshootingGateway response codesMeter namingPlatform docs publishing
Status
Docs/Build Products/Environments

Environments

Use stage and production safely while building products.

PreviousUpstream routingNextDeveloper portals

On this page

When to use an environmentEnvironment trafficTypical workflowWhat to keep separatePlatform docs environments

Environments let you test product configuration before production subscribers depend on it.

When to use an environment

Use a stage environment when you are changing:

  • upstream routing
  • product docs
  • meters
  • plan limits
  • payment behavior
  • gateway enforcement behavior

Stage should answer: will this product behave correctly when it is live?

Environment traffic

Environment traffic can use different hostnames, docs bundles, upstreams, or branches, but it follows the same product model. That means the test is close to production without forcing you to risk production subscribers.

Typical workflow

  1. Create or update the product in stage.
  2. Publish stage runtime configuration.
  3. Subscribe with a test subscriber.
  4. Issue a stage API key.
  5. Send gateway traffic through the stage hostname.
  6. Confirm usage events and limits behave correctly.
  7. Promote the same product shape to production.

What to keep separate

Use separate credentials for stage and production. Avoid sharing:

  • subscriber API keys
  • upstream secrets
  • payment test data
  • customer-facing docs drafts

Platform docs environments

The platform docs site works differently from product environments. Stage and production platform docs both read the latest main commit from this docs repo, but each environment publishes into its own R2 bucket and serves from its own host.