Simulator commands

Beta
View as Markdown

Postman Simulator is available on Postman Solo, Team, and Enterprise plans. For more information, see the pricing page.

This topic covers simulator commands for the Postman CLI.

postman simulate run

You can use the postman simulate run command to start a local mock server with a simulation applied to it. This enables you to observe how your service responds to disruptions and performance constraints. With simulations, you can identify and fix issues before deploying to staging or production.

The command runs the simulator configuration file that defines the mock server and selected scenarios for simulating real-world conditions.

Add this command to your CI/CD script to run your service against simulated dependencies. This enables you to catch issues related to latency, errors, and rate limits before changes are deployed. Once running, your service or external tests can send requests to the mock server URL and observe the responses with the simulated conditions applied.

To run a collection with a simulation, use the --simulate option with the postman collection run command.

To create a simulation and apply it to a mock server, see Simulate real-world conditions in Postman.

Usage

$postman simulate run <simulation-name>.sim.yaml
<simulation-name>

The path to the <simulation-name>.sim.yaml configuration file.

Example

$postman simulate run postman/simulations/<simulation-name>.sim.yaml