Environment Management
Environments let you define different configurations for your APIs — development, staging, production, or any custom setup. Each environment carries its own service endpoint URLs, authentication profiles and variable values; the set of variable names, on the other hand, belongs to the environment manager as a whole — see Variables.
Switching the active environment decides where requests go. Under Default, a manual request or a
test step sends the URL it carries itself, and you can edit that URL. Under any other environment, the
environment's endpoint for that service is the host — the URL field shows it and locks, and the send
uses it. ${variable} substitution applies to whichever host was chosen, so one variable per
environment can repoint every service at once. The full rule, including free-form requests and the
Restore button, is in Which URL a Request Uses.
Environment Management is organized as a window with an Actions row, an environment tab strip, and four content tabs.
Actions row
| Action | |
|---|---|
| Compare Endpoints | Side-by-side comparison of service endpoints across environments |
| Compare Variables | Side-by-side comparison of environment variables across environments |
| Export Selected Environment | Export the selected environment as a JSON file |
| Import from File | Import an environment from a JSON file |
Environment tab strip
Each environment is shown as a tab. A small color dot identifies it visually.
- The Default environment shows a lock icon
and the bold label "Default". It is the base configuration, synchronized to all other environments, and cannot be deleted.
- Non-default environments show their name and a delete (×) button
.
Add Environment creates a new environment.
Copy Environment duplicates the selected environment.
The Default environment cannot have a custom color (see Properties below).
Service Endpoints tab
A data grid lists the base URLs for your API services:
| Column | Description |
|---|---|
| Service Name | The service name as it appears in the service tree |
| Endpoint | Base URL for this service in this environment |
- Clean Up Unused Services removes endpoints for services that no longer exist in the service tree.
- Each endpoint row has an inline Test connection button (visible when the value is a network URI) that reports success
or failure
.
Authentication Profiles tab
Manage reusable credentials for your API services. The left list shows profiles with their auth sub-type; the right side is an edit form (or an onboarding panel when nothing is selected).
| Action | |
|---|---|
| Add Profile | Create a new authentication profile |
| Delete Profile | Delete the selected authentication profile |
The edit form fields are:
| Field | Description |
|---|---|
| Profile Name | Display name of the credential |
| Auth Method | Single dropdown selecting the method (HTTP Basic, Bearer Token, API Key, OAuth2, Kafka SASL) |
| Type | Read-only, derived from the selected Auth Method |
| Username / Password | Shown for username/password methods |
| OAuth2 flow | Configuration panel shown when OAuth2 is selected |
The onboarding panel lists the supported auth methods: HTTP Basic, Bearer Token, API Key, OAuth2, Kafka SASL. Create a profile once, then select it in any request — no need to re-enter usernames, tokens, or API keys.
Variables tab
A data grid of key-value pairs. The variable names belong to the environment manager, not to one environment: Add Variable creates the row in every environment of that project at once, a new environment inherits the names from Default, and what each environment holds on its own is the value. Use Compare Variables to see one name across the environments side by side.
| Column | Description |
|---|---|
| Name | Variable name — reference it in requests as ${VariableName}; the name itself is written bare where a field asks for a variable |
| Value | The variable value (masked as •••••• when the type is a password) |
| Type | Plain or password; the type combobox is locked once set to password, and locked entirely in non-Default environments |
| Action | |
|---|---|
| Add Variable | Add a new variable |
| Delete Variable | Delete the selected variable |
Variables resolve in the request URL and the operation's path and query, in header names and values, in
cookies, in the body, and in the expected values of assertions. Two places deliberately do not substitute:
an Authorization value applied from a credential profile is a stored value, not a template, and the
OAuth2 flow's own fields resolve ${…} against the active environment's variables only — a variable
captured into the case or suite scope is not visible there.
Example: an endpoint URL https://${Host}/api/v2/users resolves to https://staging.example.com/api/v2/users when the Host variable is set.
Properties tab
Contains the Appearance expander with a Color picker used to visually distinguish the environment in the tab bar and project editor. The Default environment cannot have a custom color and shows the message "The Default environment cannot have a custom color."