Run collections with file uploads using Newman

Tags:
By Abhijit Kane

Reading Time: 2 minutes

People have asked how to use the collection runner to run collections which have requests with file uploads. Right now, it’s not possible to upload files in the collection runner. However, you can use Newman, Postman’s command-line companion, as a workaround:

  1. Create a collection in Postman. Check out a sample collection here:

    This collection sends a single POST request, with two form parameters – one file param, and one text param.  The file that was used is https://gist.github.com/abhijitkane/4aba1c3deeb4ed61a623. The request runs successfully in the main Postman window:

Postman run successful
  1. Export the file as JSON (Collection > Export > V2), and save it to your filesystem.
  2. Open the JSON file for editing. In the request.body.formdata section, change the “src” property of the file param to the complete path of the file:
Edited collection file
  1. Run the collection JSON file using Newman:
Collection successfully run in Newman

If you are using Windows, be sure to change the backslashes (\) in the JSON file to double-backslashes so that the JSON remains valid, e.g. if your “value” is “C:\Documents\collection.json”, you’ll need to change it to “C:\\Documents\\collection.json”.

This is an updated post from Using Newman to run collections with file-post requests.

0

Abhijit Kane

  

    View all posts by Abhijit Kane

    Comments

    Your email address will not be published. Required fields are marked *


    This site uses Akismet to reduce spam. Learn how your comment data is processed.

    5 thoughts on “Run collections with file uploads using Newman”

    • flightcom
      April 21, 2018

      Hi,
      Thanks for this article. However I have a question regarding integration as a git hook in a team project. As every user has a different configuration, file path won’t be the same from one machine to another. How can we make this more “dynamic” so everybody can use the same collection file ?

      0
    • Rasika
      December 5, 2019

      Hi ,

      Thanks for this article . I need one help , we are using raw data file in post command, We are sending file where we are exepecting some parameters value should get replaced with global variables values . We are unable to achieve this … can someone please help?

      0
      • Arlemi Turpault
        December 17, 2020

        Hey, that shouldn’t happen, please post on the community forum if you’re still facing this issue: community.postman.com

        0
    • Douglas
      August 25, 2020

      Very useful, ty.

      0
    • Satheesh Jayabalan
      September 28, 2020

      Can this “src” be parameterized to take input from JSON file.

      I have a requirement to import many files and the list of file names will be from input JSON data file. Does post man have this capability ?

      0

    You might also like:

    How to Make Money Using Postman: Chaining Requests

    Most people already know how to send a lone request using Postman. Send it off, inspect the response you get from the server. Make some adjustments, and then try it again. That’s all well and good. However, when you save one or more requests to a collection, you can start using some of the more…

    Read More

    Integrate API tests with Postman, Newman, and Travis CI

    API testing is hard, but it doesn’t have to be. Postman makes it easy to write tests, make sure they’re working, set up the testing environment, and then eventually hook it all up to your build system. More than ever before, developers are using Postman tests in their Continuous Integration or Continuous Delivery pipeline. Continuous…

    Read More

    Using the Newman Docker Image in Windows, Hassle-Free

    Docker is one of the most well known container technologies and is quite the rage these days. We at Postman love Docker for its simplicity. It helps us by allowing a single software release to work on Windows, Mac-OSX and Linux, is extremely easy to set up, and abstracts away platform specific quirks of dependencies….

    Read More