Core Plugins and tasks Download
CertifiedDownload a file over HTTP(S) to Kestra storage.
Core Plugins and tasks Download
Download a file over HTTP(S) to Kestra storage.
Performs an HTTP request and streams the response body into internal storage. Validates Content-Length when present and can fail on empty responses (failOnEmptyResponse, unless options.allowFailed allows it). Filename is taken from saveAs, Content-Disposition, or derived from the URI.
type: io.kestra.plugin.core.http.DownloadExamples
Download a CSV file.
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.csvProperties
uri *Requiredstring
The fully-qualified URI that points to the HTTP destination
body string
The full body as a string
contentType string
application/jsonThe request content type
failOnEmptyResponse booleanstring
trueShould the task fail when downloading an empty file.
formData object
The form data to be send
headers object
The headers to pass to the request
method string
GETThe HTTP method to use
options Non-dynamic
{
"followRedirects": "true",
"allowFailed": "false",
"enabledTcpExtendedKeepAlive": "true",
"defaultCharset": "UTF-8"
}The HTTP request options
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
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.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
params object
The query string parameter to use
Adds parameter to URI query. The parameter name and value are expected to be unescaped and may contain non ASCII characters.
The value can be a string or a list of strings.
This method will not override parameters already existing on uri and will add them as array.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
saveAs string
Name of the file inside the output.
If not provided, the filename will be extracted from the Content-Disposition header.
If no Content-Disposition header, a name would be generated.
Outputs
code integer
The status code of the response
headers object
The headers of the response
length integer
The content-length of the response
uri string
uriThe URL of the downloaded file in Kestra's internal storage
Metrics
response.length counter
The content length
