Skip to main content

Environments

Environments are reusable groups of routes and responses that can be shared across simulations and teams.

What Are Environments?​

An environment packages a set of related API routes into a portable unit. Use environments to:

  • Share mock configurations across team members
  • Version your API mocks alongside your code
  • Publish to the SureStage library for organization-wide reuse
  • Import community or partner-provided mock templates

Creating an Environment​

  1. Navigate to Environments in the sidebar
  2. Click New Environment
  3. Add metadata:
    • Name - Descriptive name (e.g., "Stripe Payment API v2")
    • Description - What the environment simulates
    • Tags - Categorization labels
  4. Add routes manually or import from an existing simulation

From an Existing Simulation​

  1. Open a simulation
  2. Select the routes you want to include
  3. Click Save to Environment
  4. Choose an existing environment or create a new one

Using Environments​

Apply to a Simulation​

  1. Open a target simulation
  2. Click Import > From Environment
  3. Browse or search available environments
  4. Select and apply - routes are added to the simulation

Versioning​

Environments support semantic versioning:

  • Publish a version to lock the configuration
  • Update the draft to make changes
  • Compare versions to see what changed

Library​

The organization library contains published environments available to all team members. Admins can curate featured environments and manage access.

Next Steps​

  • Flows - Chain environment endpoints into test scenarios
  • Imports - Import from external sources