ByteChefComponents
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 | Description | Required |
|---|---|---|---|---|
| key | Key | STRING | true | |
| value | Value | STRING | true | |
| addTo | Add to | STRING OptionsHEADER, 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 | false |
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 | false |
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 | false |
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 Optionstrue, false | Download the response even if SSL certificate validation is not possible. | false |
| responseType | Response Format | STRING OptionsJSON, XML, TEXT, BINARY | The format in which the data gets returned from the URL. | false |
| responseFilename | Response Filename | STRING | The name of the file if the response is returned as a file object. | false |
| headers | Headers | OBJECT Properties{} | Headers to send. | false |
| queryParameters | Query Parameters | OBJECT Properties{} | Query parameters to send. | false |
| fullResponse | Full Response | BOOLEAN Optionstrue, false | Returns the full response data instead of only the body. | false |
| followAllRedirects | Follow All Redirects | BOOLEAN Optionstrue, false | Follow non-GET HTTP 3xx redirects. | false |
| followRedirect | Follow GET Redirect | BOOLEAN Optionstrue, false | Follow GET HTTP 3xx redirects. | false |
| ignoreResponseCode | Ignore Response Code | BOOLEAN Optionstrue, false | Succeeds also when the status code is not 2xx. | false |
| proxy | Proxy | STRING | HTTP proxy to use. | false |
| timeout | Timeout | INTEGER | Time in ms to wait for the server to send a response before aborting the request. | false |
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 Optionstrue, false | Download the response even if SSL certificate validation is not possible. | false |
| responseType | Response Format | STRING OptionsJSON, XML, TEXT, BINARY | The format in which the data gets returned from the URL. | false |
| responseFilename | Response Filename | STRING | The name of the file if the response is returned as a file object. | false |
| headers | Headers | OBJECT Properties{} | Headers to send. | false |
| queryParameters | Query Parameters | OBJECT Properties{} | Query parameters to send. | false |
| body | Body | OBJECT Properties{STRING(bodyContentType), {}(bodyContent), {}(bodyContent), {}(bodyContent), {}(bodyContent), STRING(bodyContent), FILE_ENTRY(bodyContent), STRING(bodyContentMimeType), STRING(bodyContentMimeType)} | The body of the request. | false |
| fullResponse | Full Response | BOOLEAN Optionstrue, false | Returns the full response data instead of only the body. | false |
| followAllRedirects | Follow All Redirects | BOOLEAN Optionstrue, false | Follow non-GET HTTP 3xx redirects. | false |
| followRedirect | Follow GET Redirect | BOOLEAN Optionstrue, false | Follow GET HTTP 3xx redirects. | false |
| ignoreResponseCode | Ignore Response Code | BOOLEAN Optionstrue, false | Succeeds also when the status code is not 2xx. | false |
| proxy | Proxy | STRING | HTTP proxy to use. | false |
| timeout | Timeout | INTEGER | Time in ms to wait for the server to send a response before aborting the request. | false |
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 Optionstrue, false | Download the response even if SSL certificate validation is not possible. | false |
| responseType | Response Format | STRING OptionsJSON, XML, TEXT, BINARY | The format in which the data gets returned from the URL. | false |
| responseFilename | Response Filename | STRING | The name of the file if the response is returned as a file object. | false |
| headers | Headers | OBJECT Properties{} | Headers to send. | false |
| queryParameters | Query Parameters | OBJECT Properties{} | Query parameters to send. | false |
| body | Body | OBJECT Properties{STRING(bodyContentType), {}(bodyContent), {}(bodyContent), {}(bodyContent), {}(bodyContent), STRING(bodyContent), FILE_ENTRY(bodyContent), STRING(bodyContentMimeType), STRING(bodyContentMimeType)} | The body of the request. | false |
| fullResponse | Full Response | BOOLEAN Optionstrue, false | Returns the full response data instead of only the body. | false |
| followAllRedirects | Follow All Redirects | BOOLEAN Optionstrue, false | Follow non-GET HTTP 3xx redirects. | false |
| followRedirect | Follow GET Redirect | BOOLEAN Optionstrue, false | Follow GET HTTP 3xx redirects. | false |
| ignoreResponseCode | Ignore Response Code | BOOLEAN Optionstrue, false | Succeeds also when the status code is not 2xx. | false |
| proxy | Proxy | STRING | HTTP proxy to use. | false |
| timeout | Timeout | INTEGER | Time in ms to wait for the server to send a response before aborting the request. | false |
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 Optionstrue, false | Download the response even if SSL certificate validation is not possible. | false |
| responseType | Response Format | STRING OptionsJSON, XML, TEXT, BINARY | The format in which the data gets returned from the URL. | false |
| responseFilename | Response Filename | STRING | The name of the file if the response is returned as a file object. | false |
| headers | Headers | OBJECT Properties{} | Headers to send. | false |
| queryParameters | Query Parameters | OBJECT Properties{} | Query parameters to send. | false |
| body | Body | OBJECT Properties{STRING(bodyContentType), {}(bodyContent), {}(bodyContent), {}(bodyContent), {}(bodyContent), STRING(bodyContent), FILE_ENTRY(bodyContent), STRING(bodyContentMimeType), STRING(bodyContentMimeType)} | The body of the request. | false |
| fullResponse | Full Response | BOOLEAN Optionstrue, false | Returns the full response data instead of only the body. | false |
| followAllRedirects | Follow All Redirects | BOOLEAN Optionstrue, false | Follow non-GET HTTP 3xx redirects. | false |
| followRedirect | Follow GET Redirect | BOOLEAN Optionstrue, false | Follow GET HTTP 3xx redirects. | false |
| ignoreResponseCode | Ignore Response Code | BOOLEAN Optionstrue, false | Succeeds also when the status code is not 2xx. | false |
| proxy | Proxy | STRING | HTTP proxy to use. | false |
| timeout | Timeout | INTEGER | Time in ms to wait for the server to send a response before aborting the request. | false |
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 Optionstrue, false | Download the response even if SSL certificate validation is not possible. | false |
| responseType | Response Format | STRING OptionsJSON, XML, TEXT, BINARY | The format in which the data gets returned from the URL. | false |
| responseFilename | Response Filename | STRING | The name of the file if the response is returned as a file object. | false |
| headers | Headers | OBJECT Properties{} | Headers to send. | false |
| queryParameters | Query Parameters | OBJECT Properties{} | Query parameters to send. | false |
| fullResponse | Full Response | BOOLEAN Optionstrue, false | Returns the full response data instead of only the body. | false |
| followAllRedirects | Follow All Redirects | BOOLEAN Optionstrue, false | Follow non-GET HTTP 3xx redirects. | false |
| followRedirect | Follow GET Redirect | BOOLEAN Optionstrue, false | Follow GET HTTP 3xx redirects. | false |
| ignoreResponseCode | Ignore Response Code | BOOLEAN Optionstrue, false | Succeeds also when the status code is not 2xx. | false |
| proxy | Proxy | STRING | HTTP proxy to use. | false |
| timeout | Timeout | INTEGER | Time in ms to wait for the server to send a response before aborting the request. | false |
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"
}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.
HEAD
Name: head
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 Optionstrue, false | Download the response even if SSL certificate validation is not possible. | false |
| responseType | Response Format | STRING OptionsJSON, XML, TEXT, BINARY | The format in which the data gets returned from the URL. | false |
| responseFilename | Response Filename | STRING | The name of the file if the response is returned as a file object. | false |
| headers | Headers | OBJECT Properties{} | Headers to send. | false |
| queryParameters | Query Parameters | OBJECT Properties{} | Query parameters to send. | false |
| fullResponse | Full Response | BOOLEAN Optionstrue, false | Returns the full response data instead of only the body. | false |
| followAllRedirects | Follow All Redirects | BOOLEAN Optionstrue, false | Follow non-GET HTTP 3xx redirects. | false |
| followRedirect | Follow GET Redirect | BOOLEAN Optionstrue, false | Follow GET HTTP 3xx redirects. | false |
| ignoreResponseCode | Ignore Response Code | BOOLEAN Optionstrue, false | Succeeds also when the status code is not 2xx. | false |
| proxy | Proxy | STRING | HTTP proxy to use. | false |
| timeout | Timeout | INTEGER | Time in ms to wait for the server to send a response before aborting the request. | false |
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.