tweakstreet-logo
  • Enter search terms

Http Request

Perform a Http request

Processing

For every input row, the step performs an HTTP request and provides the response as step results.

Settings

Name Type Description
Request
Method
 string

The http method

Evaluated for each input row
URL
 string

The http or https URL to call

Evaluated for each input row
URL Parameters
 list

URL parameters to add.

Specified URL parameters are properly encoded and added to the URL.

Each entry in the list is a dict with :name and :value keys.

Evaluated for each input row
Headers
 list

Any http headers to set.

Each header entry in the list is a dict with :name and :value keys.

Evaluated for each input row
Cookies
 list

A list of cookies

Pass a list of cookies generated by previos HTTP requests.

If any of the cookies are a match for the URL, they will be included in the request.

Evaluated for each input row
Content Type
 string

Adds a Content-Type header.

Set to nil to not add a Content-Type header.

Evaluated for each input row
Body Parameters
 list

Constructs a request body compatible with the application/x-www-form-urlencoded content type.

Each parameter entry in the list is a dict with :name and :value keys.

If body parameters are specified, the body setting must be empty or nil, since it is not going to be used.

Evaluated for each input row
Body
 string

The http body to send in the request

Evaluated for each input row
Auth
User
 string

Username to send when authentication is required

Basic, Digest, and NTLM authentication is supported

Evaluated for each input row
Password
 string

Password to use when authentication is required

Basic, Digest, and NTLM authentication is supported

Evaluated for each input row
OAuth 2.0
 string

Use the given OAuth 2.0 credential to authenticate the request.

Evaluated for each input row
Timeouts
Connect Timeout
 long

Time period in milliseconds in which the client should establish a connection with the target host.

The step throws an error if a successful connection is not established within the given period.

A value of 0 disables the timeout.

Evaluated for each input row
Read Timeout
 long

A read timeout is applied from the moment the connection to the target host has been successfully established.

It defines a maximum time of inactivity in milliseconds between two data packets when waiting for the server’s response.

A value of 0 disables the timeout.

Evaluated for each input row
Response
Follow Redirects
 boolean

If enabled, the step automatically follows HTTP redirects issued by the server.

Evaluated for each input row
Response Body
 string

Determines how the body of the response is handled.

  • save to file: saves the response body to a file on disk, the target filename is given by the Save Location setting
  • capture as string result: makes the response body available in results.response_body as a string and results.response_json
  • capture as binary result: makes the response body available in results.response_body as a binary value
  • ignore: ignores the response body, potentially closing the connection to remote early

Evaluated for each input row
Save Location
 string

If response is saved to file, the file is saved to this path.

Evaluated for each input row

Results

Name Type Description
success
 boolean request success as indicated by status code
status
 long http status code of response
response_headers
 dict response headers as dict of the form {"header_name" ["value1", "value2", ...], ...}
response_body
 string response body as string
response_json
 any Response body parsed as JSON
cookies
 list list of cookies provided by the server response, any cookies passed as input are preserved with expired cookies removed
On this page