HTTP

The HTTP component is a generic component that allows users to make requests to external HTTP APIs. It can carry out the following tasks:

Get
Post
Patch
Put
Delete
Head
Options

Release Stage

Alpha

Configuration

The component definition and tasks are defined in the definition.yaml and tasks.yaml files respectively.

Setup

In order to communicate with the external application, the following connection details need to be provided. You may specify them directly in a pipeline recipe as key-value pairs within the component's setup block, or you can create a Connection from the Integration Settings page and reference the whole setup as setup: ${connection.<my-connection-id>}.

Field	Field ID	Type	Note
Authentication (required)	`authentication`	object	Authentication method to use for the REST API.

The authentication Object

Authentication

authentication must fulfill one of the following schemas:

`No Auth`

Field	Field ID	Type	Note
Auth Type	`auth-type`	string	Must be `"NO_AUTH"`

`Basic Auth`

Field	Field ID	Type	Note
Auth Type	`auth-type`	string	Must be `"BASIC_AUTH"`
Password	`password`	string	Password for Basic auth.
Username	`username`	string	Username for Basic Auth.

`API Key`

Field	Field ID	Type	Note
Auth Location	`auth-location`	string	Add the API key to the header or query params. Enum values `header` `query`
Auth Type	`auth-type`	string	Must be `"API_KEY"`
Key Name	`key`	string	Key name for API key authentication.
Key Value	`value`	string	Key value for API key authentication.

`Bearer Token`

Field	Field ID	Type	Note
Auth Type	`auth-type`	string	Must be `"BEARER_TOKEN"`
Token	`token`	string	Bearer token.

Supported Tasks

Get

Send a HTTP GET request.

Input	Field ID	Type	Description
Task ID (required)	`task`	string	`TASK_GET`
Endpoint URL (required)	`endpoint-url`	string	The API endpoint URL. It must be a valid URI reference and point to an external IP address. If the URL resolves to an internal or private IP, the component will throw an error.
Body	`output-body-schema`	string	The request body.
Header	`header`	json	The HTTP header of the response. It must be an object whose values are arrays of strings.

Output	Field ID	Type	Description
Status Code	`status-code`	integer	The HTTP status code of the response.
Body	`body`	any	The body of the response.
Header	`header`	json	The HTTP header of the response.

Post

Send a HTTP POST request.

Input	Field ID	Type	Description
Task ID (required)	`task`	string	`TASK_POST`
Endpoint URL (required)	`endpoint-url`	string	The API endpoint URL. It must be a valid URI reference and point to an external IP address. If the URL resolves to an internal or private IP, the component will throw an error.
Body	`body`	any	The request body.
Body	`output-body-schema`	string	The JSON schema of output body.
Header	`header`	json	The HTTP header of the response. It must be an object whose values are arrays of strings.

Output	Field ID	Type	Description
Status Code	`status-code`	integer	The HTTP status code of the response.
Body	`body`	any	The body of the response.
Header	`header`	json	The HTTP header of the response.

Patch

Send a HTTP PATCH request.

Input	Field ID	Type	Description
Task ID (required)	`task`	string	`TASK_PATCH`
Endpoint URL (required)	`endpoint-url`	string	The API endpoint URL. It must be a valid URI reference and point to an external IP address. If the URL resolves to an internal or private IP, the component will throw an error.
Body	`body`	any	The request body.
Body	`output-body-schema`	string	The JSON schema of output body.
Header	`header`	json	The HTTP header of the response. It must be an object whose values are arrays of strings.

Output	Field ID	Type	Description
Status Code	`status-code`	integer	The HTTP status code of the response.
Body	`body`	any	The body of the response.
Header	`header`	json	The HTTP header of the response.

Put

Send a HTTP PUT request.

Input	Field ID	Type	Description
Task ID (required)	`task`	string	`TASK_PUT`
Endpoint URL (required)	`endpoint-url`	string	The API endpoint URL. It must be a valid URI reference and point to an external IP address. If the URL resolves to an internal or private IP, the component will throw an error.
Body	`body`	any	The request body.
Body	`output-body-schema`	string	The JSON schema of output body.
Header	`header`	json	The HTTP header of the response. It must be an object whose values are arrays of strings.

Output	Field ID	Type	Description
Status Code	`status-code`	integer	The HTTP status code of the response.
Body	`body`	any	The body of the response.
Header	`header`	json	The HTTP header of the response.

Delete

Send a HTTP DELETE request.

Input	Field ID	Type	Description
Task ID (required)	`task`	string	`TASK_DELETE`
Endpoint URL (required)	`endpoint-url`	string	The API endpoint URL. It must be a valid URI reference and point to an external IP address. If the URL resolves to an internal or private IP, the component will throw an error.
Body	`body`	any	The request body.
Body	`output-body-schema`	string	The JSON schema of output body.
Header	`header`	json	The HTTP header of the response. It must be an object whose values are arrays of strings.

Output	Field ID	Type	Description
Status Code	`status-code`	integer	The HTTP status code of the response.
Body	`body`	any	The body of the response.
Header	`header`	json	The HTTP header of the response.

Head

Send a HTTP HEAD request.

Input	Field ID	Type	Description
Task ID (required)	`task`	string	`TASK_HEAD`
Endpoint URL (required)	`endpoint-url`	string	The API endpoint URL. It must be a valid URI reference and point to an external IP address. If the URL resolves to an internal or private IP, the component will throw an error.
Body	`output-body-schema`	string	The request body.
Header	`header`	json	The HTTP header of the response. It must be an object whose values are arrays of strings.

Output	Field ID	Type	Description
Status Code	`status-code`	integer	The HTTP status code of the response.
Body	`body`	any	The body of the response.
Header	`header`	json	The HTTP header of the response.

Options

Send a HTTP OPTIONS request.

Input	Field ID	Type	Description
Task ID (required)	`task`	string	`TASK_OPTIONS`
Endpoint URL (required)	`endpoint-url`	string	The API endpoint URL. It must be a valid URI reference and point to an external IP address. If the URL resolves to an internal or private IP, the component will throw an error.
Body	`body`	any	The request body.
Body	`output-body-schema`	string	The JSON schema of output body.
Header	`header`	json	The HTTP header of the response. It must be an object whose values are arrays of strings.

Output	Field ID	Type	Description
Status Code	`status-code`	integer	The HTTP status code of the response.
Body	`body`	any	The body of the response.
Header	`header`	json	The HTTP header of the response.