Skip to main content
Issues an HTTP request. The simplified form takes the URL as a single string and issues a GET. Store the response with saveAs.

​
Parameters

ParameterTypeRequiredDescription
urlstringYesRequest URL.
methodstringNoHTTP method. Defaults to GET.
headersRecord<string, string>NoRequest headers.
paramsRecord<string, string>NoQuery parameters.
bodystringNoRequest body.
bodyTypestringNoBody encoding (e.g. JSON, form).
timeoutnumberNoRequest timeout in milliseconds.
saveAsstringNoVariable to store this step’s return value on env.<name>.
retriesnumberNoTimes to retry the step on failure before failing the test.
skippedbooleanNoSkip this step at execution time.

​
Shorthand

URL as a single string. 
- request: https://api.example.com/health

​
Examples

- request:
    url: https://api.example.com/orders
    method: POST
    headers:
      Authorization: "Bearer {{ env.TOKEN }}" # interpolate a saved variable
    body: '{ "item": "blanket" }'
    bodyType: json
    saveAs: ORDER # response is available as {{ env.ORDER }}