Download
Download a file from an HTTP server.
Download a file from an HTTP server.
Download a file from an HTTP server.
This task connects to a HTTP server and copies a file to Kestra's internal storage.
type: "io.kestra.plugin.core.http.Download"Examples
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
bodystring
The full body as a string
contentTypestring
application/jsonThe request content type
failOnEmptyResponsebooleanstring
trueShould the task fail when downloading an empty file.
formDataobject
The form data to be send
headersobject
The headers to pass to the request
methodstring
GETThe HTTP method to use
optionsNon-dynamic
{
"followRedirects": "true",
"allowFailed": "false",
"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 authentification 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.
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.
durationdurationThe 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 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
DIRECTDIRECTHTTPSOCKSThe 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.
durationdurationThe 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
durationThe time allowed to establish a connection to the server before failing.
PT5MdurationThe time allowed for a read connection to remain idle before closing it.
paramsobject
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.
saveAsstring
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
codeinteger
The status code of the response
headersobject
The headers of the response
lengthinteger
The content-length of the response
uristring
uriThe URL of the downloaded file in Kestra's internal storage
Metrics
response.lengthcounter
The content length
