Download from sandbox with YAML

YAML parameters for Download from sandbox

Hint

List with common parameters for all Buddy actions

Name	Type	Description
action `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `DOWNLOAD_FROM_SANDBOX`.
source_path	String	The path from which the file will be downloaded.
destination_path	String	The path in which the file will be saved.
deployment_excludes	String[]	The paths and/or files that will be excluded from the upload.
deployment_includes	String[]	The exceptions from the ignore patterns set in `deployment_excludes`.
sandbox_references `Required`	String	Defines the sandbox selection method. Available values: `BY_TAGS`, `BY_NAME`, `BY_PROJECT`, `BY_DAYS`, `BY_ID`, `BY_ACTION`.
sandbox_id	String	The ID of the sandbox to which the files are uploaded. Required when `sandbox_references` is set to `BY_ID`.
referenced_action_id	Int	The ID of the action that creates the target sandbox. Required when `sandbox_references` is set to `BY_ACTION`.
referenced_sanbox_name	String	The name of the target sandbox. Required when `sandbox_references` is set to `BY_NAME`.
tags	String[]	The list of tags applied to the target sandbox. Required when `sandbox_references` is set to `BY_TAGS`.
sandbox_project_name	String	The name of the project with the target sandbox. Required when `sandbox_references` is set to `BY_PROJECT`.
days	Int	The number of days passed since the creation of the target sandbox. One of `1`, `2`, `3`, `7`, `14`, `30`. Required when `sandbox_references` is set to `BY_DAYS`.
recursive	Boolean	If set to `true`, the whole directory tree is downloaded. Otherwise only the files from the path are downloaded.
overwrite	Boolean	Replace files if they already exist.

YAML example for Download from sandbox

yaml
actions:
- action: "Download files from a sandbox"
  type: "DOWNLOAD_FROM_SANDBOX"
  source_path: "/assets/"
  destination_path: "/"
  sandbox_references:
  - "BY_ID"
  sandbox_id: "Cgn3QO34klUri"
  recursive: true
  overwrite: true
  deployment_excludes:
  - "/tmp/"
  deployment_includes:
  - "/tmp/file.txt"

Last modified on Apr 9, 2025

Download Backblaze B2 Download GCS

On this page

YAML parameters for Download from sandbox YAML example for Download from sandbox