Get file

The Get action downloads an object from a MinIO bucket and saves it to a file on the local file system.

This is useful when another part of your setup needs a file that is stored in MinIO, for example to retrieve a camera snapshot or a backup that was uploaded earlier.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

Prerequisites

• The file path must be added to allowlist_external_dirs in configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more].

To download a file from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. From the search box, search for and select Minio: Get.
6. Enter the Bucket, the Key of the object, and the File path to save it to.
7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as minio.get. A basic example looks like this:

action: minio.get
data:
  bucket: "camera-files"
  key: "front_camera/snapshot.jpg"
  file_path: "/data/camera_files/snapshot.jpg"

This downloads the object to the given path on the local file system.

Options in YAML

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

More examples

Real scenarios where this action shows up in automations and scripts. Copy any example and adapt it to your setup.

Automation: download a file when it is added to a bucket

When MinIO reports that an object was created, download it to the local file system.

• Trigger: A MinIO bucket event for a created object
• Action: Minio: Get

alias: "Download new MinIO object"
triggers:
  - trigger: event
    event_type: minio
actions:
  - action: minio.get
    data:
      bucket: "{{ trigger.event.data.bucket }}"
      key: "{{ trigger.event.data.key }}"
      file_path: "/tmp/{{ trigger.event.data.key | basename }}"

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Put file: Uploads a file from the local file system to a MinIO bucket.

• Remove file: Deletes a file from a MinIO bucket.