HTTP requests
Supply an HTTP URL for an action to use as an input, or to call an upstream API.
interfaces:
http/basic:
output: http
method: GET
actions:
- name: BasicHTTP
http:
url: https://jsonplaceholder.typicode.com/todos/1
HTTP actions also support auth (bearer / basic / digest), TLS options, multipart uploads, automatic pagination, and reverse-proxy passthrough. Every field is documented below.
HttpRequest
| Field | Type | Description |
|---|---|---|
url | string | Required. |
digest_auth_user | string (nullable) | |
digest_auth_pass | string (nullable) | |
user | string (nullable) | |
pass | string (nullable) | |
proxy | string (nullable) | |
headers | Map<string, string> (nullable) | |
body | any | |
base64_bytes | string (nullable) | |
method | string (nullable) | |
data_type | DataType (nullable) | |
bearer_auth | string (nullable) | |
multipart | Array<MultipartPart> (nullable) | A flat list of parts for a multipart/form-data request. Each entry is one form part. Whether it is a text or binary part is determined implicitly by which source field is… |
multipart_form | Map<string, string> (nullable) | Deprecated: use multipart instead. |
multipart_files | Array<MultipartData> (nullable) | Deprecated: use multipart instead. |
accept_invalid_certs | boolean (nullable) | |
ca | string (nullable) | |
root_certificates | Array<string> (nullable) | |
timeout | string (nullable) | |
connect_timeout | string (nullable) | |
pagination | Pagination (nullable) | |
proxy_body | boolean (nullable) | |
proxy_method | boolean (nullable) | |
proxy_headers | ProxyHeaders (nullable) | |
proxy_query | boolean (nullable) |
Pagination
| Field | Type | Description |
|---|---|---|
original_url | string (nullable) | |
next_link | string (nullable) | |
no_pages | number | Default: 0. |
page_marker | number | Default: 0. |
cursor_marker | string (nullable) | |
increment | number | Default: 1. |
max_pages | number (nullable) | |
max_pages_key | string (nullable) | |
page_start | number | Default: 1. |
page_next_key | string (nullable) | |
page_limit | number (nullable) | |
page_limit_key | string (nullable) | |
payload_key | string (nullable) | |
next_cursor_key | string (nullable) | |
max_cursor_key | string (nullable) | |
next_link_key | string (nullable) | |
next_link_host | string (nullable) |
MultipartPart
A single part in a multipart/form-data request.
Exactly one of value, b64, or file_path must be provided per part.
All other fields are optional.
| Field | Type | Description |
|---|---|---|
name | string | Required. Form field name — the name attribute sent in Content-Disposition. |
value | string (nullable) | Plain text value. Use this for non-binary form fields. Mutually exclusive with b64 and file_path. |
b64 | string (nullable) | Base64-encoded binary data. Decoded before sending. Mutually exclusive with value and file_path. |
file_path | string (nullable) | Path to a file to read and send as binary data. Not permitted in managed/hosted mode — use b64 instead. Mutually exclusive with value and b64. |
filename | string (nullable) | Filename sent in the Content-Disposition header for this part (e.g. photo.png). Optional for binary parts; not meaningful for plain text parts. |
mime | string (nullable) | MIME type for this part (e.g. image/png, application/pdf). If omitted on a binary part, guessed from filename's extension. Falls back to application/octet-stream when… |
MultipartData
Deprecated: use [MultipartPart] via the multipart field instead.
One of:
MultipartFile
Deprecated: use [MultipartPart] via the multipart field instead.
| Field | Type | Description |
|---|---|---|
file_path | string (nullable) | |
file_name | string | Required. |
b64 | string (nullable) | |
mime_str | string (nullable) | |
part_name | string (nullable) |
MultipartText
Deprecated: use [MultipartPart] via the multipart field instead.
| Field | Type | Description |
|---|---|---|
key | string | Required. |
value | string | Required. |
mime_str | string (nullable) |
ProxyHeaders
Controls which headers are passed through from the incoming request.
One of:
- boolean — When true, pass through all incoming headers
- Array<string> — When a list, pass through only the specified headers; empty list means pass none