Runscope is now part of BlazeMeter.
Please find up-to-date documentation at guide.blazemeter.com.
Please find up-to-date API documentation at api.blazemeter.com.

API Monitoring & Testing: File Uploads

The File Uploads feature requires a qualifying plan. Please contact Sales to get started.

The File Uploads feature enables teams to upload files to their Runscope account that can be used to test and monitor endpoints that require multipart/form-data information, such as uploading a JSON file, an image, or a combination of multiple file types.



Uploading Files to the File Library

Important: only team owners can see the File Uploads menu and upload or delete files.

Click on your profile on the top-right, and select "File Uploads" from the drop-down:

The Runscope logged in dashboard, highlighting the File Uploads option on the user's drop-down menu

On the "Upload a file" section, click on the "Select file" button to choose the file you want to upload. After that, click on the "Upload" button to upload your file. The maximum file size accepted is 5 MB, and there are no restrictions on file extensions:

The File Library page view that a team owner can access, showing a file named photo.jpg being uploaded

You should now see your file available under the "Existing Files" section, as well as a new entry under the "History" section:

The File Library page view that a team owner can access, showing the photo.jpg file uploaded in the last step under the section Existing Files, and History

Making Requests with a Multipart File Body

Select a bucket and create a new test, or open an existing test in the test editor:

The Create Test screen, showing a new test with the name Image Endpoint being created

Create a new Request step, and set your endpoint method to "POST", "PUT", "PATCH", or "DELETE". Then, under Parameters, click on "+ Add Multipart Form Parameters":

An API test in editor mode, highlighting a POST request test step and the Add Multipart Form Parameters option

Give your file parameter a name (required), and click on the drop-down next to it to select the file from your available uploaded files. Runscope will try to set the Content-Type based on the file extension you have selected, such as application/json or image/jpeg, but you can also manually edit it:

An API test in editor mode, highlighting the parameters created after clicking on the Add Multipart Form Parameters option, showing a header with the name image, and the value photo.jpg from a drop-down, and another header for Content-Type, and value image/jpeg

Click on Save & Run! After your test runs, you can click on the new test run result on the left-hand side to check the details for your request. By expanding the details of a successful request step with the multipart file body, you should see:

  • Under the Request tab, the file that you uploaded with your request (clicking on the link will download that file), as well as the body that we parsed and sent to the endpoint.
  • Under the Response tab, any files that were returned by the API (clicking on the link will download that file), as well as any other headers and body information.

Managing Files

Only the team owner can access and manage a team's files. In the File Uploads page you can find three main sections: "Upload a File", "Existing Files", and "History".

  • Upload a File allows the team owner to upload files to the team's account. There is a limit of 5 MB per file, and a total limit of 50 files per team.
  • Existing Files will display all the files that are available for use under the account's team. You can see the filenames as well as delete any files by clicking on the trash icon on the right-side.
  • History will display a timeline of all the actions related to uploading and deleting files. You can see which user uploaded or deleted which files, as well as a timestamp with the exact time.

Need help? We have you covered.

View the docs or contact our support team and we'll get back to you as soon as we're able to respond.