Environments¶

Overview¶

The Environments feature in Yappes lets you create and manage gateway environments — named environments with one or more domains used for gateway routing, API deployment, and related Gateway Control workflows.

With this feature, you can:

Create gateway environments with custom domain mappings.
Designate one environment as the default environment.
View, edit, and delete environments from a single list.
Search environments by name.

Gateway environments are also referenced when creating Applications, configuring KVM Store entries, creating Upstream targets, and deploying APIs via Release Snapshot and Deployment Environment.

Path: API Manager → Gateway Control → Environments

Why This Matters¶

Separate gateway domains for the same API across different deployment contexts.
A single default environment for baseline gateway routing.
Controlled domain assignment with uniqueness checks across environments.
Foundation for deploying release snapshots into gateway environments.

Prerequisites¶

Required Access and Permissions¶

Users must have:

API Manager access.
Permission to manage gateway environments.

System / Technical Requirements¶

Valid organization context in the API Manager.
Domain hostnames ready for assignment (no protocol prefixes or path segments).
At least one unattached dataplane available to assign. Register dataplanes in Yappes Fleet Dataplane if none appear in the selector.

Environment List¶

Search: Matches environment name only.

Click Create Environment to open the create form.

Column	Type	Description
`Environment Name`	Data	Name shown in the list
`No.of.Domains`	Data	Count of domains on the environment
`Created date & time`	Data	When the environment was created
`View`	Action	Opens `View Environment`
`Edit`	Action	Opens `Update Environment`
`Delete`	Action	Opens `Delete Environment`

Note

Empty grid: No environments have been created yet. The default environment has no Default column — its row is highlighted instead.

Environment Fields¶

Field	Required	Description
`Environment name`	Yes	Display name. Must start with a letter (`Start with a letter, no special characters.`) and be at least 3 characters (`Min 3 characters required`).
`Description`	No	Optional notes. Maximum 500 characters.
`Domains`	Yes	At least one hostname (for example, `api.example.com`).
`Dataplane`	Yes	Unattached, non-decommissioned dataplane. On edit, the current assignment stays available. If it is `Decommissioned`, the selection clears and you must choose another.
`Make Default Environment`	No	Marks this environment as the platform default. Only one default at a time.

Domain Validation Rules¶

Rule	Detail
Format	Hostname only — no `http://` / `https://`, no path, no `*.` wildcards
Whitespace	No spaces in a domain value
Uniqueness (form)	No duplicate domains in the same environment
Uniqueness (platform)	Domain cannot already belong to another environment
Minimum rows	At least one domain row; the last row cannot be removed

Step-by-Step Implementation¶

Creating an Environment¶

Step 1: Navigate to Environments¶

From the left navigation panel, open Gateway Control → Environments.

Step 2: Open the Create Form¶

Click Create Environment.

Step 3: Enter Environment Details¶

Enter Environment name and optional Description.
Enter at least one domain under Domains.
Select a dataplane.
Optionally enable Make Default Environment.

No unattached dataplanes

If no dataplanes are available to attach, the form shows: "There are no data planes available to attach to this environment. Please ask your administrator to create one." Create Environment stays disabled until an administrator registers an unattached dataplane in Yappes Fleet Dataplane.

Step 4: Manage Domain Rows¶

Click Add Domain to add another domain row. This button is disabled until all existing domain rows are valid and non-empty.
Use the remove control on a domain row to delete it. Removal is disabled when only one domain row remains.

Step 5: Confirm Default Change (if applicable)¶

If you enable Make Default Environment and another default already exists, a Change default environment confirmation appears. Review the message and confirm to proceed.

Changing the default environment

Only one environment can be the default at a time. Confirming assigns default status to the new environment and removes it from the current default. The previous default environment remains available in the list but is no longer marked as default.

Step 6: Save¶

Click Create Environment.

Success

The environment is successfully created and appears in the environments list.

Viewing and Editing an Environment¶

Step 1: Open View or Edit¶

In the environments list, click View (eye icon) to open View Environment, or click Edit to open Update Environment directly.

Step 2: Review Details (View)¶

The View Environment dialog shows all fields in read-only mode.

Step 3: Switch to Edit Mode (from View)¶

From View Environment, click Edit to open Update Environment.

Step 4: Apply Changes¶

Update allowed fields and click Update Environment.

Success

The environment is successfully updated and the list refreshes with your changes.

Edit constraints:

Condition	Behavior
Environment is the default	`Make Default Environment` is locked on with the message: "This is the default environment, so this cannot be turned off here."
Environment is attached to an API	The first domain row is read-only. Helper text: "The first domain cannot be changed or removed while this environment is attached to an API."
Environment is the default	The first domain row is read-only. Helper text: "The first domain cannot be changed or removed on the default environment."
Assigned dataplane is Decommissioned	Dataplane selection is cleared; choose another available dataplane.
No fields changed	Error: "Please modify values to initiate an update."

Deleting an Environment¶

Step 1: Open Delete Confirmation¶

In the environments list, click Delete (trash icon) on the target row.

Step 2: Review Summary¶

The Delete Environment dialog shows:

Environment name
No.of.Domains
Created Date
Dataplane

Step 3: Confirm or Cancel¶

Click Delete to remove the environment, or Cancel to close without changes.

Delete constraints (blocked before the API call):

Condition	Message
Environment is the default	"You cannot delete the default environment. Choose another environment as default, then delete this one."
Environment is attached to an API	"You cannot delete the environment that is attached to an API."

To delete a former default environment, first assign another environment as default, then delete the old one.

Best Practices¶

Practice	Reason
Register dataplanes before creating environments	Each environment requires an unattached dataplane
Plan domains before creation	Domains must be unique across all environments
Keep one clear default environment	Simplifies deployment and platform defaults
Use descriptive environment names	Easier search and audit in the list
Detach or reassign APIs before deleting	Environments attached to APIs cannot be deleted
Change default before deleting the old default	Default environments cannot be deleted directly

Troubleshooting¶

Issue	Possible Cause	Resolution
Duplicate domain error	Same domain entered twice in the form	Remove or change the duplicate domain
Domain already in use	Domain assigned to another environment	Choose a different hostname or edit the other environment
No dataplanes in the selector	All dataplanes are already attached, none are registered, or only decommissioned dataplanes remain	Ask an administrator to register an unattached dataplane in Yappes Fleet Dataplane
Unable to load dataplanes	Dataplane list request failed	Retry opening the form; UI message: "Unable to load dataplanes. Please try again." Confirm Admin Console / fleet connectivity
Create Environment disabled	No unattached dataplane available	Register an unattached dataplane, then reopen `Create Environment`
Cannot delete environment	Environment is default or attached to an API	Assign a new default and/or detach APIs first
Cannot change first domain	Environment is default or attached to an API	Add or edit additional domain rows instead
Add Domain disabled	Existing domain rows are empty or invalid	Complete validation on all current rows
Update rejected with no changes	Form values match the saved record	Change at least one field before saving
Default switch locked on edit	Editing the current default environment	Assign another environment as default first if you need to remove default status
Dataplane cleared on edit	Assigned dataplane is `Decommissioned`	Select another available dataplane and save

Frequently Asked Questions¶

What is a gateway environment?

A gateway environment is a named set of domains used by the API gateway for routing and deployment. It is separate from backend service URLs configured during API onboarding.

How many default environments can exist?

Only one environment can be the default at a time. Changing the default requires confirmation when another default already exists.

Can I use the same domain in two environments?

No. Each domain must be unique across all gateway environments.

Tip

Create and validate gateway environments before deploying APIs. Next: create a Release Snapshot, then deploy it from Deployment Environment.