Download

Download a file from an HTTP server.

This task connects to a HTTP server and copies a file to Kestra's internal storage.

yaml
type: "io.kestra.plugin.core.http.Download"

Examples

Download a CSV file.

yaml
id: download
namespace: company.team

tasks:
  - id: extract
    type: io.kestra.plugin.core.http.Download
    uri: https://huggingface.co/datasets/kestra/datasets/raw/main/csv/orders.csv

Properties

uri *string

The fully-qualified URI that points to the HTTP destination

body string

The full body as a string

contentType string

Default application/json

The request content type

failOnEmptyResponse booleanstring

Default true

Should the task fail when downloading an empty file.

formData object

The form data to be send

headers object

SubType string

The headers to pass to the request

method string

Default GET

The HTTP method to use

options HttpConfiguration

Default

{
  "followRedirects": "true",
  "allowFailed": "false",
  "defaultCharset": "UTF-8"
}

The HTTP request options

Outputs

code integer

The status code of the response.

headers object

SubType array

The headers of the response.

length integer

The content-length of the response.

uri string

Format uri

The URL of the downloaded file on Kestra's internal storage.

Metrics

response.length counter

The content length

Definitions

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeout string

Format duration

The time allowed to establish a connection to the server before failing.

readIdleTimeout string

Default PT5M

Format duration

The time allowed for a read connection to remain idle before closing it.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type *object

password string

The password for HTTP basic authentication.

username string

The username for HTTP basic authentication.

java.nio.charset.Charset

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailed booleanstring

Default false

If true, allow a failed response code (response code >= 400)

allowedResponseCodes array

SubType integer

List of response code allowed for this request

auth BasicAuthConfiguration BearerAuthConfiguration

The authentification to use.

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

followRedirects booleanstring

Default true

Whether redirects should be followed automatically.

logs array

SubType string

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy ProxyConfiguration

The proxy configuration.

ssl SslOptions

The SSL request options

timeout TimeoutConfiguration

The timeout configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

address string

The address of the proxy server.

password string

The password for proxy authentication.

port integerstring

The port of the proxy server.

type string

Default DIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

username string

The username for proxy authentication.

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificates booleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type *object

token string

The token for bearer token authentication.

​Download

Download