When making API requests, it is often necessary to switch between development, testing, and production environments. Apidog makes it convenient to send requests to different environments—you simply need to click and select the desired environment at the top right corner of the interface.An Apidog environment consists of two core elements:1.
Base URL: Maintains the target of request delivery.
2.
Variables: Groups of variables that can be referenced in requests or scripts.
Create an Environment#
1
Open Environment ManagementClick on the Environment Management button ≡ in the top right corner of the interface.
2
Create New EnvironmentClick on the last item in the left-side list labeled New Environment.
3
Configure EnvironmentEnter a name for your new environment. Add the Base URL and variables. 5
Select EnvironmentTo use the new environment, select it from the environment selector at the top right of the interface. This makes it the active environment and sets all variables to the values specified in the environment.
Apidog maintains a clear separation between environments and base URLs. Environments represent different deployment stages (development, testing, production), while base URLs are configured within each environment. This separation provides flexibility when managing multiple services or micro-services across different environments.In contrast, Apidog's environments directly reflect real environments like development, testing, and production, rather than treating each base URL as a single environment.
Base URLs#
The Base URL is the primary feature in an Apidog environment. In Apidog, an endpoint path usually starts with a forward slash (/) and does not include the base URL. When sending a request, Apidog prepends the destination Base URL to the endpoint path.A standardized Base URL format begins with the protocol and excludes the trailing slash (/).Each Base URL corresponds to a specific Module. In most cases, an endpoint will use the Base URL of its module to send requests.For instance, if the Base URL of the default module for the Production environment is http://abc.com/v1 and your endpoint path is /pet, then when you send a request in the Production environment, the actual request URL sent would be:If the endpoint path begins with http:// or https://, the Base URL will not be appended. However, hardcoding full URLs in endpoints is generally discouraged.
In Apidog, there is a special environment variable called BASE_URL which stores the Base URL for the "Default Server" of the current environment. It is generally discouraged to use this variable directly.Recommended: Use pm.request.getBaseUrl() to fetch the Base URL for the current endpoint.
Avoid: Using pm.environment.get('BASE_URL'), as it may not correctly capture the Base URL if the endpoint does not occupy the "Default Server".
BASE_URL, it will supersede the system's predefined BASE_URL.Note: Scripts cannot modify the Base URL configuration itself. The command pm.environment.set('BASE_URL', 'My_url') will only create a variable named BASE_URL. Using Multiple Base URLs with Modules#
If your project’s endpoints need to connect to multiple Base URLs (e.g., microservices), the best way to manage them is by using multiple Modules in Apidog.User endpoints: https://user.example.com
Order endpoints: https://order.example.com
Product endpoints: https://product.example.com
1
Create ModulesAt the top of the API folder tree, add multiple modules corresponding to your services. 2
Configure Base URLsIn Environment Management, you’ll see fields to set the Base URL for each module. Enter the URLs for each environment and click Save. 3
Set Module Base URLIn a module’s root folder settings, choose which Base URL the module’s endpoints should use.Default Settings: Uses the first Base URL listed for that module (Recommended).
Manually Specify: Select another Base URL manually. (Not recommended for most cases).
4
InheritanceIn subfolders or individual endpoints, you can also specify the Base URL.Inherit from Parents: Follows the parent folder (Default).
Manually Specify: Override for specific items.
5
Send RequestsOnce set up, just click Send. Apidog determines the proper Base URL based on module and environment settings.
Add Environment Variables#
When you add a variable to an environment, you can specify two values:Initial value: Shared with the team.
Current value: Stored locally on your machine.
Switch Between Environments#
Apidog shows the current environment in the environment selector at the top right of the workbench. Whenever you make a request or execute a script, Apidog will use the current values for all variables in the selected environment.To switch, simply choose a different environment from the selector.Endpoint: The API specification (path usually starts with /).
Request: The actual HTTP request sent (includes the full URL).
{{Base_url}} syntax if needed.Environment Migration#
In Apidog, the Initial value of variables is synchronized within the team, while the Current value is only stored locally. This means current values do not carry over to other devices.Apidog provides export/import functionality to migrate environments (including local current values) between machines.1
ExportIn Environment Management, hover over the ... next to the environment, click Export to get a JSON file. 2
ImportOn the target computer, open Environment Management, hover over ..., click Import, and select the JSON file.
Visibility Scope of Environments#
You can create Private Environments for variables you don't want to share.In the top right corner of the environment settings, set the visibility scope.Shared: Visible to the team (Default).
Private: Visible only to you.
Private Environments share the same Service list (Base URLs) as other environments. Adding or removing services in a Private Environment will affect all environments simultaneously.
FAQ#
How to get service Base URL in a custom script?Use pm.request.getBaseUrl() to retrieve the Base URL of the current endpoint. 
