Environments
Environments represent deployment targets in your API lifecycle. Each environment has its own gateway instance, endpoint URLs, and configuration.
Typical Setup
Section titled “Typical Setup”Most organisations configure three environments:
| Environment | Purpose | Gateway Instance |
|---|---|---|
| Development | Integration testing, early feedback | Dev gateway |
| Staging | Pre-production validation, load testing | Staging gateway |
| Production | Live traffic | Production gateway |
How Environments Work
Section titled “How Environments Work”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.
Environment-Specific Configuration
Section titled “Environment-Specific Configuration”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
Promoting Across Environments
Section titled “Promoting Across Environments”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.
Gateway Instances
Section titled “Gateway Instances”A gateway instance is a running gateway that can serve API traffic. Apiway supports multiple gateway types:
| Gateway | Worker |
|---|---|
| Alpha Gateway | alpha-worker |
| Kong | kong-worker |
| Azure API Management | azure-worker |
| Apigee | apigee-worker |
| Tyk | tyk-worker |
| Zuplo | zuplo-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.
Managing Environments
Section titled “Managing Environments”# List environmentscurl https://operations.api.apiway.net/v1/environments \ -H "Authorization: Bearer $TOKEN"
# Get environment detailscurl https://operations.api.apiway.net/v1/environments/{id} \ -H "Authorization: Bearer $TOKEN"Navigate to Operations > Environments to view and manage your environment configuration, gateway credentials, and IdP settings.