Configure request and collection runs using the Postman Runtime library

The Postman Runtime library is an open-source Node.js project you can use for low-level configuration over request sending in your API development and testing projects. It supports request sending and collection running in Postman and other interfaces including the Postman CLI.

Accessing the Postman Runtime library

To get started with the Runtime library, check out the repo’s README.

You can install the library from npm. The following example code shows a simplified outline of using the Runtime library in conjunction with the Collection SDK:

1
runtime = require('postman-runtime');
2
var runner = new runtime.Runner();
3
4
// Collection object constructed using the Collection SDK
5
var collection = new sdk.Collection();
6
7
runner.run(collection, {
8
  data: [],
9
  timeout: {
10
    request: 30000,
11
    script: 5000
12
  },
13
  iterationCount: 1,
14
15
  //other options...
16
17
},
18
function (err, run) {
19
  // Callbacks to run as the collection runs
20
  run.start(callbacks);
21
});

You can use the Runtime library if you need a detailed configuration of your request runs. For example, it can be used as part of an automation workflow to integrate Postman Collection runs into your development pipeline.

Next steps

After you’ve gotten started with the Runtime library, you might also want to use the Postman API in your continuous integration and continuous deployment (CI/CD) workflow:

• To learn more about incorporating Postman into your CI/CD workflow, visit Explore Postman’s command-line companion.