http-post.md

HTTP POST Step

The POST step allows for making POST requests with the input information.

post_step:
  call: http.post
  args:
    url: https://www.example-url.com
    body:
      test: "param"
  result: responseVariable

Mandatory fields:

• call, with value http.post - determines the step type
• args
  • url - the desired resource to query
  • body
    • ..desired body values - Scripts can be used for body values

Optional fields:

• args
  • query
    • ..desired query values - Scripts can be used for query values
  • headers
    • ..desired header values - Scripts can be used for headers values
  • result - name of the variable to store the response of the query in, for use in other steps

Note: POST step responses are stored the same way as GET step responses

Examples

Standard POST step with its result used in other step

post-with-used-response.yml

post_step:
  call: http.post
  args:
    url: http://localhost:8080/scripting/passing-post-parameters
    body:
      project: "byk"
      website: "krat.ee"
  result: the_message

return_value:
  return: ${the_message.response}

Back to Guide