Skip to content

Http Request

Node: httpRequest · Full type: n8n-nodes-base.httpRequest · Version: 4.4

Ergonomic keyword available: HTTP — see NFLOW.md for shorter syntax.

Credentials

httpSslAuth (alias: @http)

CREDENTIAL @http = httpSslAuth "My Http Request"

Parameters

Parameter Type Default Details
method options "GET" DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT
url string "" required
authentication options "none" none, predefinedCredentialType, genericCredentialType
provideSslCertificates boolean false
sendQuery boolean false
specifyQuery options "keypair" keypair, json
queryParameters fixedCollection {...} groups: parameters
jsonQuery json ""
sendHeaders boolean false
specifyHeaders options "keypair" keypair, json
headerParameters fixedCollection {...} groups: parameters
jsonHeaders json ""
sendBody boolean false
contentType options "json" form-urlencoded, multipart-form-data, json, binaryData, raw
specifyBody options "keypair" keypair, json
bodyParameters fixedCollection {...} groups: parameters
jsonBody json ""
body string ""
inputDataFieldName string ""
rawContentType string ""
options collection {} keys: batching, allowUnauthorizedCerts, queryParameterArrays, lowercaseHeaders, redirect, redirect, ...
optimizeResponse boolean false
responseType options "json" json, html, text
dataField string ""
fieldsToInclude options "all" all, selected, except
fields string ""
cssSelector string "body"
onlyContent boolean false
elementsToOmit string ""
truncateResponse boolean false
maxLength number 1000

queryParameters children:

parameters group:

Parameter Type Default Details
name string ""
value string ""

headerParameters children:

parameters group:

Parameter Type Default Details
name string ""
value string ""

bodyParameters children:

parameters group:

Parameter Type Default Details
name string ""
value string ""

options children:

Parameter Type Default Details
batching fixedCollection {...} groups: batch
allowUnauthorizedCerts boolean false
queryParameterArrays options "brackets" repeat, brackets, indices
lowercaseHeaders boolean true
redirect fixedCollection {...} groups: redirect
redirect fixedCollection {...} groups: redirect
response fixedCollection {...} groups: response
pagination fixedCollection {...} groups: pagination
proxy string ""
timeout number 10000
sendCredentialsOnCrossOriginRedirect boolean false

Example

NODE "httpRequest" @http AS "Http Request" {
  url: {{ $json.url }}
}