Use the Collection Runner from the Postman VS Code extension

View as Markdown

With the Postman VS Code extension, you can use the Collection Runner to manually run a collection’s or folder’s requests in a specific sequence. This enables you to test an API’s functionality or performance. You can also automate collection runs in your CI/CD with the Postman CLI.

To learn more about manual collection runs in Postman, see Test your API using the Collection Runner.

Configure a collection run

To manually run requests in a collection or folder, do the following:

  1. Select a collection or folder with requests you want to run in sequence.
  2. Click Run icon Run to configure the collection run.
  3. To run your collection with an environment, select it using the environment selector at the upper right. You can also click Create New to create a new environment. Learn how to manage environments in the VS Code extension.
  4. Choose any configuration options. For more information each option, see Configure a collection run.
  5. To run the collection with your completed configuration, click Run (collection name).

Your Postman plan gives you a limited number of collection runs you can use each month. This limit applies to collections you run manually. A collection run with multiple iterations counts as a single run.

Debug run results

When running collections manually, Postman displays the results of your request runs and test results in real time. To learn more about what happened during the collection run, you can:

  • Select a request to view more details about it, including the response, headers, and request.
  • Click the name of a request to open it in a new tab.
  • Click the Passed, Failed, or Skipped tabs to filter the results by test status. To show all requests, click the All Tests tab. If any tests in a request script fail during a collection run, the whole request fails.
  • Click View all runs to view the run history for your collection.
  • Click Run Again to run the collection again using the same settings.
  • Click Add icon New Run to configure a new run for the collection. Make changes to any settings, and then select Run (collection name) to run the collection again.

Learn more about debugging run results in Postman.

View run history

When you run a collection with the Collection Runner or Postman CLI, Postman saves the results in your run history. To view the history, select a collection, then select the Runs tab.

The run history tab provides details about each run, including:

  • The date and time of a run.
  • The run’s source (Collection Runner or the Postman CLI).
  • The duration of a run.
  • The number of tests that passed, failed, or were skipped.
  • The run’s average response time.

Use the following filters to view specific collection runs in your run history:

  • Last — Filters results by the number of collection runs to view.
  • Run by — Filters results by the user who ran the collection.
  • Run status — Filters results by the test status of the collection run, such as completed or failed.
  • Source — Filter results by the Collection Runner or Postman CLI source of the collection run.

Click a collection run to view more details, including how the request was run, the environment used, and the run’s iteration data.

To view to the run results of a collection, hover over a collection run and click Report icon View Report.

Learn more about viewing run history in Postman.