Docker icon

Docker

Interact with Docker

Actions15

Overview

This node allows interaction with Docker by performing operations on Docker resources such as containers, images, volumes, and networks. Specifically, the "List" operation for the "Volume" resource retrieves a list of Docker volumes based on optional filtering criteria.

Common scenarios where this node is beneficial include:

  • Automating Docker volume management workflows.
  • Monitoring existing Docker volumes in an environment.
  • Integrating Docker volume data into broader automation or reporting pipelines.

For example, you can use this node to fetch all Docker volumes currently available on a Docker host, optionally filtered by specific parameters, and then process or analyze that data within your workflow.

Properties

Name Meaning
Options A JSON object specifying filter options for listing volumes. This can include any valid Docker volume list filters as per Docker API specifications.

Output

The node outputs an array of JSON objects representing Docker volumes. Each object corresponds to a volume and contains its properties as returned by the Docker API's volume listing endpoint.

The output is structured as follows:

  • json: An array of volume objects with details such as volume name, driver, mountpoint, labels, scope, and usage data.
  • No binary data output is produced by this operation.

Dependencies

  • Requires a Docker environment accessible via Docker API.
  • Needs an API authentication token or credentials configured in n8n to connect to the Docker daemon securely.
  • Uses the dockerode Node.js library internally to interact with Docker.

Troubleshooting

  • No credentials got returned!
    This error indicates missing or misconfigured Docker API credentials. Ensure that the node has access to valid Docker credentials before execution.

  • Invalid JSON in Options property
    Since the "Options" input expects a JSON object, malformed JSON will cause errors. Validate the JSON syntax before running the node.

  • Docker connection issues
    Network or permission problems connecting to the Docker daemon may cause failures. Verify Docker is running and accessible from the environment where n8n executes.

Links and References

Discussion