Skip to main content

HTTP - Download File from URL to Shipyard

Overview​

This Blueprint lets you build a Vessel that downloads any file from the web given a URL. The file must be publicly accessible.

The file will be downloaded directly to the specified folder using the File Name provided.

  • If not folder is specified, the file will be downloaded to the current working directory.
  • If no file name is specified, the file name will be interpreted from the URL.

Running this as a single Vessel will appear to do nothing, as the file is being downloaded to Shipyard and then promptly deleted once the Vessel finishes, per our security measures. We recommend using this Blueprint when building a Vessel as part of a Fleet, so that the data can shared for processing and storage elsewhere.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
File URLHTTP_FILE_URLAlphanumericβœ…--URL to run a download request against.
Custom HeadersHTTP_CUSTOM_HEADERSAlphanumericβž–--A dictionary of additional headers that you want sent to the URL where the download request is being made.
File NameHTTP_DESTINATION_FILE_NAMEAlphanumericβž–--If left blank, will try to interpret the file name from the URL.
Folder NameHTTP_DESTINATION_FOLDER_NAMEAlphanumericβž–--If left blank, the file will be created in the current working directory.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: HTTP - Download File from URL to Shipyard
inputs:
HTTP_FILE_URL: null ## REQUIRED
HTTP_CUSTOM_HEADERS: null
HTTP_DESTINATION_FILE_NAME: null
HTTP_DESTINATION_FOLDER_NAME: null
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '0'