DockerInstall

Overview

This node allows interaction with Docker environments by performing operations on Docker resources such as containers, images, volumes, and networks. Specifically, for the Network - List operation, it retrieves a list of Docker networks based on optional filtering criteria provided by the user.

Common scenarios where this node is beneficial include:

• Automating Docker network management within workflows.
• Monitoring existing Docker networks to integrate with other systems.
• Extracting network details for reporting or auditing purposes.

For example, you can use this node to fetch all Docker networks or filter them by specific options (like network name or driver) to dynamically adjust your infrastructure or trigger subsequent workflow steps.

Properties

The Options property accepts any valid JSON that corresponds to Docker's network listing API filters. For instance, you might specify { "filters": { "driver": ["bridge"] } } to list only bridge networks.

Output

The node outputs an array of JSON objects representing Docker networks. Each object contains detailed information about a network, such as its ID, name, driver type, scope, and connected containers.

The output structure corresponds directly to Docker's network list response, enabling further processing or conditional logic in your workflow.

No binary data is produced by this operation.

Dependencies

• Requires a Docker environment accessible via the Docker API.
• Needs an API authentication token or credentials configured in n8n to connect securely to the Docker daemon.
• The node depends on the dockerode library internally to communicate with Docker.

Troubleshooting

• No credentials got returned!
  This error indicates missing or misconfigured Docker API credentials. Ensure that the required API key or connection details are properly set up in n8n before running the node.

• Invalid JSON in Options
  Since the Options property expects valid JSON, malformed input will cause errors. Validate your JSON syntax carefully.

• Docker connection issues
  Network problems or incorrect Docker host configuration may prevent the node from connecting. Verify Docker daemon accessibility and credentials.

Links and References

• Docker Networks Documentation
• Docker API: Network List
• dockerode GitHub Repository