PLUGINSPLUGIN-FSTASKSHTTPIO.KESTRA.PLUGIN.FS.HTTP.DOWNLOAD

​Download

Download Download

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

Download a file from a HTTP server

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

Examples

yaml
id: "download"
type: "io.kestra.plugin.fs.http.Download"
headers: 
  user-agent: "kestra-io"
uri: "https://server.com/file"

Properties

uri

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The fully-qualified URI that points to the HTTP destination

body

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The full body as a string

contentType

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The request content type

failOnEmptyResponse

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: true

Should the task fail when downloading an empty file.

formData

  • Type: object
  • Dynamic: ✔️
  • Required: ❌

The form data to be send

headers

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

The headers to pass to the request

method

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: GET
  • Possible Values:
    • OPTIONS
    • GET
    • HEAD
    • POST
    • PUT
    • DELETE
    • TRACE
    • CONNECT
    • PATCH
    • CUSTOM

The HTTP method to use

options

The HTTP request options

sslOptions

The SSL request options

Outputs

code

  • Type: integer

The status code of the response

headers

  • Type: object
  • SubType: array

The headers of the response

length

  • Type: integer

The content-length of the response

uri

  • Type: string

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

Definitions

RequestOptions

basicAuthPassword

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The HTTP basic authentication password.

basicAuthUser

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The HTTP basic authentication username.

connectTimeout

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Format: duration

The connect timeout.

connectionPoolIdleTimeout

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: 0.0
  • Format: duration

The idle timeout for connection in the client connection pool.

defaultCharset

  • Type: Charset
  • Dynamic: ❌
  • Required: ❌
  • Default: UTF-8

The default charset.

followRedirects

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: true

Whether redirects should be followed.

logLevel

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Possible Values:
    • ALL
    • TRACE
    • DEBUG
    • INFO
    • WARN
    • ERROR
    • OFF
    • NOT_SPECIFIED

The log level.

maxContentLength

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 10485760

The maximum content length of the response

proxyAddress

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The proxy address.

proxyPassword

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The proxy password.

proxyPort

  • Type: integer
  • Dynamic: ❌
  • Required: ❌

The proxy port.

proxyType

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: DIRECT
  • Possible Values:
    • DIRECT
    • HTTP
    • SOCKS

The proxy type.

proxyUsername

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The proxy username.

readIdleTimeout

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: 300.000000000
  • Format: duration

The default amount of time to allow the read connection to remain idle.

readTimeout

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: 10.000000000
  • Format: duration

The default read timeout.

SslOptions

insecureTrustAllCertificates

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

Whether the client should 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.

Metrics

response.length

  • Type: counter

The content length