HTTP Client
Methods PUT, DELETE, and HEAD available since 2022.1.2
Overview
The HTTP Client Node allows the user to send HTTP requests to a selected HTTP server. All configurations are made in the Node or in the Attributes section. There are several methods that the user can select from to perform different HTTP requests. These are: GET, POST, PUT, HEAD, and DELETE.
Scope: Project, Scene, Function, Prefab.
Common Attributes, Inputs, and Outputs
Depending on the Method
selected, the Attributes and Inputs might change. However, there are several common Attributes, Inputs, and Outputs between the many HTTP Methods
.
Common Attributes
Attribute | Type | Description |
---|---|---|
| User Input | The HTTP endpoint (either a URL or IP address). |
| Int | The port value. For HTTP, the standard is 80 and for HTTPS, the standard is 443. |
| Drop-down | Either GET, POST, PUT, HEAD, or DELETE. |
| User Input | A specific path from the call being referenced in |
| Drop-down | The user selects |
| Add Elements | HTTP headers in the form of key/value pairs. |
| Add Elements | Parameters of the call in the form of key/value pairs. |
| Bool | The user chooses true or false depending on whether they wish for the |
Common Inputs
Input | Type | Description |
---|---|---|
Pulse Input (►) | Pulse | A standard Input Pulse, to trigger the execution of the Node. |
| String | The HTTP endpoint (either a URL or IP address). |
| Int | The port value. For HTTP, the standard is 80 and for HTTPS, the standard is 443. |
| String | A specific path from the call being referenced in |
| Dictionary | HTTP headers in the form of key/value pairs. |
| Dictionary | Parameters of the call in the form of key/value pairs. |
Common Outputs
Output | Type | Description |
---|---|---|
Pulse Output (►) | Pulse | A standard Output Pulse, to move onto the next Node along the Logic Branch, once this Node has finished its execution. |
| Pulse | Flows to additional actions when there is a response. |
| Int | A standard status code within the HTTP protocol. For example, 404 is when a page is not found. |
| Dictionary | HTTP headers in the form of key/value pairs. |
| String | The body of the response, usually including HTML text. |
Methods
GET
GET creates a request and returns the response as per the HTTP protocol. This is very useful when dealing with web APIs. A more detailed explanation involving web APIs can be found in the See Also section. Additional information on the different HTTP methods can be found in the External Links section.
POST
POST sends data, in this case the information from the Request Body
, to the desired server as per the HTTP protocol. More information on the different HTTP methods can be found in the External Links section. All Attributes and Inputs are the same as the common Attributes, except for the addition of the following:
Attributes
Attribute | Type | Description |
---|---|---|
| String | The body of the HTTP request, if none is provided in the Input Socket. |
Inputs
Input | Type | Description |
---|---|---|
| String | The body of the HTTP request. |
PUT
PUT updates already existing data on the desired server per the HTTP protocol. More information on the different HTTP methods can be found in the External Links section. All Attributes and Inputs are the same as the common Attributes, except for the addition of the following:
Attributes
Attribute | Type | Description |
---|---|---|
| String | The body of the HTTP request, if none is provided in the Input Socket. |
Inputs
Input | Type | Description |
---|---|---|
| String | The body of the HTTP request. |
HEAD
HEAD requests the headers on the desired server in order to gather information about the data, but not the content of the data itself. More information on the different HTTP methods can be found in the External Links section. All Attributes and Inputs are the same as the common Attributes.
DELETE
DELETE deletes data on the desired server per the HTTP protocol. More information on the different HTTP methods can be found in the External Links section. All Attributes and Inputs are the same as the common Attributes, except for the addition of the following:
Attributes
Attribute | Type | Description |
---|---|---|
| String | The body of the HTTP request, if none is provided in the Input Socket. |
Inputs
Input | Type | Description |
---|---|---|
| String | The body of the HTTP request. |
See Also
External Links
Different HTTP Methods on W3Schools.
Last updated