Skip to end of metadata
Go to start of metadata

API Requests

Author: Jerry Chae


The API Requests plugin is based on a Python solution called “Requests” a HTTP library that simplifies sending HTTP requests. The API Requests plugin is useful when you want your automation scenario to send requests to API that are based on HTTP such as REST(RESTful) API.

For more information, please visit this link.

Useful Resources

Below are some of the online resources using which you can test your HTTP Requests (Against REST API)



Need help?

Technical contact to

May you search all operations,

Required Input

  • HTTP request method
  • URL

Optional Input

  • Parameters
  • Headers
  • Cookies
  • Json (either in String or in File)
  • Encoding options

Return Value

  • Whatever that would be retuned as “Response” to Requests will be stored in String, CSV, or File (.txt or .csv)

Result Codes

0 for Response code 200s

4 for Response code 400s

5 for Response code 500s

9 for Everything else

How to set parameters

Text from Image


This website explains various HTTP request methods. Below graphics are showing how the code will be transposed to STU’s parameter section.

1)      Case of List User

2)      Case of Single User

3)     Case of Single User Not Found

4)      Case of Create User

Return Code

0Execution successful
1Conditional Response
4Client Error
5Server Error
9Other Failures and Errors

All Plugins