Skip to content

Environments

Environments represent deployment targets in your API lifecycle. Each environment has its own gateway instance, endpoint URLs, and configuration.

Most organisations configure three environments:

EnvironmentPurposeGateway Instance
DevelopmentIntegration testing, early feedbackDev gateway
StagingPre-production validation, load testingStaging gateway
ProductionLive trafficProduction gateway

Each environment is registered in the Operations Service and associated with a gateway instance. When you deploy an API, you select the target environment — and Apiway routes the deployment to the correct worker and gateway.

Each environment can have different:

  • Gateway credentials — Connection details for the target gateway
  • OAuth/IdP infrastructure — Identity provider configuration per environment
  • Rate limits — Stricter limits in production, relaxed in development
  • Subscription quotas — Different RU budgets per environment

A typical promotion flow moves from Development → Staging → Production. Each promotion is a separate deployment — the same OAS spec is deployed to the next environment’s gateway. Governance can be configured to require additional approval for production deployments.

A gateway instance is a running gateway that can serve API traffic. Apiway supports multiple gateway types:

GatewayWorker
Alpha Gatewayalpha-worker
Kongkong-worker
Azure API Managementazure-worker
Apigeeapigee-worker
Tyktyk-worker
Zuplozuplo-worker

You can run different gateway types in different environments — for example, Alpha Gateway in development and Kong in production. Apiway’s deployment model is gateway-agnostic; the worker handles the translation.

Terminal window
# List environments
curl https://operations.api.apiway.net/v1/environments \
-H "Authorization: Bearer $TOKEN"
# Get environment details
curl https://operations.api.apiway.net/v1/environments/{id} \
-H "Authorization: Bearer $TOKEN"