Environments

An environment represents one or a group of gateways of a given platform. Environments are where APIs, API Products, plans, and subscriptions are deployed to become operational. They are the bridge between the Control Plane (management) and the Data Plane (runtime).

Each environment is assigned a stage — either development or production — which represents where the environment sits in your API lifecycle. A single environment cannot span two stages. Environments also have access modes that control who can publish APIs to them and who can subscribe through them.

The functionality of an environment depends on the capabilities of its connected agent and gateway platform. Different platforms support different features (e.g., metrics, discovery, plan enforcement). Use the latest agent version to ensure full capability support.

Key concepts

• Environment — A deployment target connected to one or more gateways. APIs must be deployed to an environment to be available on the gateway
• Stage — DEVELOPMENT or PRODUCTION. Determines the lifecycle phase and affects subscription behavior (some products require a production deployment to be subscribable)
• Agent — A lightweight component (Docker container) that transmits and translates commands between the Control Plane and your gateways. All environments except Boomi API Gateway require an agent. Minimum requirements: 512 MB RAM, 1 CPU, 5 GB disk
• Access modes — publishAccessMode controls who can deploy APIs; subscribeAccessMode controls who can subscribe. Both can be PUBLIC or RESTRICTED

Environment properties

Field	Type	Description
name	string	Unique technical name
displayName	string	Human-readable name
url	string	Environment URL
symbol	string	Short symbol (max 4 chars, e.g., "DEV")
status	enum	ACTIVE or INACTIVE
color	string	Color code for UI display
pinned	boolean	Whether pinned in the UI
stage	enum	DEVELOPMENT or PRODUCTION
platformType	enum	Gateway platform type
subscribeAccessMode	enum	PUBLIC or RESTRICTED
publishAccessMode	enum	PUBLIC or RESTRICTED
apiUrlStrategy	enum	PLATFORM_DEFAULT, PATH, or SUB_DOMAIN
agentType	enum	STANDALONE or MANAGED

Related guides

• Manage Environments — Create, list, update, and delete environments
• Discovery & Deployment — Discover APIs and manage deployments