HTTP Client

Makes an HTTP request and returns the response data.

Categories: Helpers

Type: httpClient/v1

Connections

Version: 1

API Key

Properties

Name	Label	Type	Required
key	Key	STRING	true
value	Value	STRING	true
addTo	Add to	STRING Options HEADER, QUERY_PARAMETERS	true

Bearer Token

Properties

Name	Label	Type	Description	Required
token	Token	STRING		true

Basic Auth

Properties

Name	Label	Type	Description	Required
username	Username	STRING		true
password	Password	STRING		true

Digest Auth

Properties

Name	Label	Type	Description	Required
username	Username	STRING		true
password	Password	STRING		true

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
authorizationUrl	Authorization URL	STRING		true
tokenUrl	Token URL	STRING		true
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true
headerPrefix	Header Prefix	STRING		null
scopes	Scopes	STRING	`Optional comma-delimited list of scopes`	null

OAuth2 Implicit Code

Properties

Name	Label	Type	Description	Required
authorizationUrl	Authorization URL	STRING		true
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true
headerPrefix	Header Prefix	STRING		null
scopes	Scopes	STRING	`Optional comma-delimited list of scopes`	null

OAuth2 Client Credentials

Properties

Name	Label	Type	Description	Required
tokenUrl	Token URL	STRING		true
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true
headerPrefix	Header Prefix	STRING		null
scopes	Scopes	STRING	`Optional comma-delimited list of scopes`	null

Actions

GET

Name: get

The request method to use.

Properties

Name	Label	Type	Description	Required
uri	URI	STRING	`The URI to make the request to. If HTTP Client Connection defines Base URI, then this value is appended to it.`	true
allowUnauthorizedCerts	Allow Unauthorized Certs	BOOLEAN Options true, false	`Download the response even if SSL certificate validation is not possible.`	null
responseType	Response Format	STRING Options JSON, XML, TEXT, BINARY	`The format in which the data gets returned from the URL.`	null
responseFilename	Response Filename	STRING	`The name of the file if the response is returned as a file object.`	null
headers	Headers	OBJECT Properties {}	`Headers to send.`	null
queryParameters	Query Parameters	OBJECT Properties {}	`Query parameters to send.`	null
fullResponse	Full Response	BOOLEAN Options true, false	`Returns the full response data instead of only the body.`	null
followAllRedirects	Follow All Redirects	BOOLEAN Options true, false	`Follow non-GET HTTP 3xx redirects.`	null
followRedirect	Follow GET Redirect	BOOLEAN Options true, false	`Follow GET HTTP 3xx redirects.`	null
ignoreResponseCode	Ignore Response Code	BOOLEAN Options true, false	`Succeeds also when the status code is not 2xx.`	null
proxy	Proxy	STRING	`HTTP proxy to use.`	null
timeout	Timeout	INTEGER	`Time in ms to wait for the server to send a response before aborting the request.`	null

Example JSON Structure

{
  "label" : "GET",
  "name" : "get",
  "parameters" : {
    "uri" : "",
    "allowUnauthorizedCerts" : false,
    "responseType" : "",
    "responseFilename" : "",
    "headers" : { },
    "queryParameters" : { },
    "fullResponse" : false,
    "followAllRedirects" : false,
    "followRedirect" : false,
    "ignoreResponseCode" : false,
    "proxy" : "",
    "timeout" : 1
  },
  "type" : "httpClient/v1/get"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

POST

Name: post

The request method to use.

Properties

Name	Label	Type	Description	Required
uri	URI	STRING	`The URI to make the request to. If HTTP Client Connection defines Base URI, then this value is appended to it.`	true
allowUnauthorizedCerts	Allow Unauthorized Certs	BOOLEAN Options true, false	`Download the response even if SSL certificate validation is not possible.`	null
responseType	Response Format	STRING Options JSON, XML, TEXT, BINARY	`The format in which the data gets returned from the URL.`	null
responseFilename	Response Filename	STRING	`The name of the file if the response is returned as a file object.`	null
headers	Headers	OBJECT Properties {}	`Headers to send.`	null
queryParameters	Query Parameters	OBJECT Properties {}	`Query parameters to send.`	null
body	Body	OBJECT Properties {STRING(bodyContentType), {}(bodyContent), {}(bodyContent), {}(bodyContent), {}(bodyContent), STRING(bodyContent), FILE_ENTRY(bodyContent), STRING(bodyContentMimeType), STRING(bodyContentMimeType)}	`The body of the request.`	null
fullResponse	Full Response	BOOLEAN Options true, false	`Returns the full response data instead of only the body.`	null
followAllRedirects	Follow All Redirects	BOOLEAN Options true, false	`Follow non-GET HTTP 3xx redirects.`	null
followRedirect	Follow GET Redirect	BOOLEAN Options true, false	`Follow GET HTTP 3xx redirects.`	null
ignoreResponseCode	Ignore Response Code	BOOLEAN Options true, false	`Succeeds also when the status code is not 2xx.`	null
proxy	Proxy	STRING	`HTTP proxy to use.`	null
timeout	Timeout	INTEGER	`Time in ms to wait for the server to send a response before aborting the request.`	null

Example JSON Structure

{
  "label" : "POST",
  "name" : "post",
  "parameters" : {
    "uri" : "",
    "allowUnauthorizedCerts" : false,
    "responseType" : "",
    "responseFilename" : "",
    "headers" : { },
    "queryParameters" : { },
    "body" : {
      "bodyContentType" : "",
      "bodyContent" : {
        "extension" : "",
        "mimeType" : "",
        "name" : "",
        "url" : ""
      },
      "bodyContentMimeType" : ""
    },
    "fullResponse" : false,
    "followAllRedirects" : false,
    "followRedirect" : false,
    "ignoreResponseCode" : false,
    "proxy" : "",
    "timeout" : 1
  },
  "type" : "httpClient/v1/post"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

PUT

Name: put

The request method to use.

Properties

Name	Label	Type	Description	Required
uri	URI	STRING	`The URI to make the request to. If HTTP Client Connection defines Base URI, then this value is appended to it.`	true
allowUnauthorizedCerts	Allow Unauthorized Certs	BOOLEAN Options true, false	`Download the response even if SSL certificate validation is not possible.`	null
responseType	Response Format	STRING Options JSON, XML, TEXT, BINARY	`The format in which the data gets returned from the URL.`	null
responseFilename	Response Filename	STRING	`The name of the file if the response is returned as a file object.`	null
headers	Headers	OBJECT Properties {}	`Headers to send.`	null
queryParameters	Query Parameters	OBJECT Properties {}	`Query parameters to send.`	null
body	Body	OBJECT Properties {STRING(bodyContentType), {}(bodyContent), {}(bodyContent), {}(bodyContent), {}(bodyContent), STRING(bodyContent), FILE_ENTRY(bodyContent), STRING(bodyContentMimeType), STRING(bodyContentMimeType)}	`The body of the request.`	null
fullResponse	Full Response	BOOLEAN Options true, false	`Returns the full response data instead of only the body.`	null
followAllRedirects	Follow All Redirects	BOOLEAN Options true, false	`Follow non-GET HTTP 3xx redirects.`	null
followRedirect	Follow GET Redirect	BOOLEAN Options true, false	`Follow GET HTTP 3xx redirects.`	null
ignoreResponseCode	Ignore Response Code	BOOLEAN Options true, false	`Succeeds also when the status code is not 2xx.`	null
proxy	Proxy	STRING	`HTTP proxy to use.`	null
timeout	Timeout	INTEGER	`Time in ms to wait for the server to send a response before aborting the request.`	null

Example JSON Structure

{
  "label" : "PUT",
  "name" : "put",
  "parameters" : {
    "uri" : "",
    "allowUnauthorizedCerts" : false,
    "responseType" : "",
    "responseFilename" : "",
    "headers" : { },
    "queryParameters" : { },
    "body" : {
      "bodyContentType" : "",
      "bodyContent" : {
        "extension" : "",
        "mimeType" : "",
        "name" : "",
        "url" : ""
      },
      "bodyContentMimeType" : ""
    },
    "fullResponse" : false,
    "followAllRedirects" : false,
    "followRedirect" : false,
    "ignoreResponseCode" : false,
    "proxy" : "",
    "timeout" : 1
  },
  "type" : "httpClient/v1/put"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

PATCH

Name: patch

The request method to use.

Properties

Name	Label	Type	Description	Required
uri	URI	STRING	`The URI to make the request to. If HTTP Client Connection defines Base URI, then this value is appended to it.`	true
allowUnauthorizedCerts	Allow Unauthorized Certs	BOOLEAN Options true, false	`Download the response even if SSL certificate validation is not possible.`	null
responseType	Response Format	STRING Options JSON, XML, TEXT, BINARY	`The format in which the data gets returned from the URL.`	null
responseFilename	Response Filename	STRING	`The name of the file if the response is returned as a file object.`	null
headers	Headers	OBJECT Properties {}	`Headers to send.`	null
queryParameters	Query Parameters	OBJECT Properties {}	`Query parameters to send.`	null
body	Body	OBJECT Properties {STRING(bodyContentType), {}(bodyContent), {}(bodyContent), {}(bodyContent), {}(bodyContent), STRING(bodyContent), FILE_ENTRY(bodyContent), STRING(bodyContentMimeType), STRING(bodyContentMimeType)}	`The body of the request.`	null
fullResponse	Full Response	BOOLEAN Options true, false	`Returns the full response data instead of only the body.`	null
followAllRedirects	Follow All Redirects	BOOLEAN Options true, false	`Follow non-GET HTTP 3xx redirects.`	null
followRedirect	Follow GET Redirect	BOOLEAN Options true, false	`Follow GET HTTP 3xx redirects.`	null
ignoreResponseCode	Ignore Response Code	BOOLEAN Options true, false	`Succeeds also when the status code is not 2xx.`	null
proxy	Proxy	STRING	`HTTP proxy to use.`	null
timeout	Timeout	INTEGER	`Time in ms to wait for the server to send a response before aborting the request.`	null

Example JSON Structure

{
  "label" : "PATCH",
  "name" : "patch",
  "parameters" : {
    "uri" : "",
    "allowUnauthorizedCerts" : false,
    "responseType" : "",
    "responseFilename" : "",
    "headers" : { },
    "queryParameters" : { },
    "body" : {
      "bodyContentType" : "",
      "bodyContent" : {
        "extension" : "",
        "mimeType" : "",
        "name" : "",
        "url" : ""
      },
      "bodyContentMimeType" : ""
    },
    "fullResponse" : false,
    "followAllRedirects" : false,
    "followRedirect" : false,
    "ignoreResponseCode" : false,
    "proxy" : "",
    "timeout" : 1
  },
  "type" : "httpClient/v1/patch"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

DELETE

Name: delete

The request method to use.

Properties

Name	Label	Type	Description	Required
uri	URI	STRING	`The URI to make the request to. If HTTP Client Connection defines Base URI, then this value is appended to it.`	true
allowUnauthorizedCerts	Allow Unauthorized Certs	BOOLEAN Options true, false	`Download the response even if SSL certificate validation is not possible.`	null
responseType	Response Format	STRING Options JSON, XML, TEXT, BINARY	`The format in which the data gets returned from the URL.`	null
responseFilename	Response Filename	STRING	`The name of the file if the response is returned as a file object.`	null
headers	Headers	OBJECT Properties {}	`Headers to send.`	null
queryParameters	Query Parameters	OBJECT Properties {}	`Query parameters to send.`	null
fullResponse	Full Response	BOOLEAN Options true, false	`Returns the full response data instead of only the body.`	null
followAllRedirects	Follow All Redirects	BOOLEAN Options true, false	`Follow non-GET HTTP 3xx redirects.`	null
followRedirect	Follow GET Redirect	BOOLEAN Options true, false	`Follow GET HTTP 3xx redirects.`	null
ignoreResponseCode	Ignore Response Code	BOOLEAN Options true, false	`Succeeds also when the status code is not 2xx.`	null
proxy	Proxy	STRING	`HTTP proxy to use.`	null
timeout	Timeout	INTEGER	`Time in ms to wait for the server to send a response before aborting the request.`	null

Example JSON Structure

{
  "label" : "DELETE",
  "name" : "delete",
  "parameters" : {
    "uri" : "",
    "allowUnauthorizedCerts" : false,
    "responseType" : "",
    "responseFilename" : "",
    "headers" : { },
    "queryParameters" : { },
    "fullResponse" : false,
    "followAllRedirects" : false,
    "followRedirect" : false,
    "ignoreResponseCode" : false,
    "proxy" : "",
    "timeout" : 1
  },
  "type" : "httpClient/v1/delete"
}

Name	Label	Type	Description	Required
uri	URI	STRING	`The URI to make the request to. If HTTP Client Connection defines Base URI, then this value is appended to it.`	true
allowUnauthorizedCerts	Allow Unauthorized Certs	BOOLEAN Options true, false	`Download the response even if SSL certificate validation is not possible.`	null
responseType	Response Format	STRING Options JSON, XML, TEXT, BINARY	`The format in which the data gets returned from the URL.`	null
responseFilename	Response Filename	STRING	`The name of the file if the response is returned as a file object.`	null
headers	Headers	OBJECT Properties {}	`Headers to send.`	null
queryParameters	Query Parameters	OBJECT Properties {}	`Query parameters to send.`	null
fullResponse	Full Response	BOOLEAN Options true, false	`Returns the full response data instead of only the body.`	null
followAllRedirects	Follow All Redirects	BOOLEAN Options true, false	`Follow non-GET HTTP 3xx redirects.`	null
followRedirect	Follow GET Redirect	BOOLEAN Options true, false	`Follow GET HTTP 3xx redirects.`	null
ignoreResponseCode	Ignore Response Code	BOOLEAN Options true, false	`Succeeds also when the status code is not 2xx.`	null
proxy	Proxy	STRING	`HTTP proxy to use.`	null
timeout	Timeout	INTEGER	`Time in ms to wait for the server to send a response before aborting the request.`	null

Example JSON Structure

{
  "label" : "HEAD",
  "name" : "head",
  "parameters" : {
    "uri" : "",
    "allowUnauthorizedCerts" : false,
    "responseType" : "",
    "responseFilename" : "",
    "headers" : { },
    "queryParameters" : { },
    "fullResponse" : false,
    "followAllRedirects" : false,
    "followRedirect" : false,
    "ignoreResponseCode" : false,
    "proxy" : "",
    "timeout" : 1
  },
  "type" : "httpClient/v1/head"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

On this page