Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Container → Container Archive Info

AI-generated

Overview

This node interacts with Docker containers through the Portainer API, specifically allowing users to retrieve archive information about files or directories inside a container's filesystem. The "Container Archive Info" operation fetches metadata or archive data for a specified path within a given container.

Common scenarios include:

  • Inspecting or backing up specific files or folders inside a running container.
  • Automating retrieval of configuration files or logs stored within containers.
  • Integrating container file inspection into broader workflows for monitoring or auditing purposes.

For example, you might use this node to get an archive of the /var/log directory from a container to analyze logs externally.

Properties

Name Meaning
EndpointID Name or ID Selects the Portainer endpoint to access Docker. You can choose from a list of available endpoints or specify one via expression. This determines which Docker environment the request targets.
Id The ID or name of the Docker container from which to retrieve the archive info.
Path The path inside the container’s filesystem that you want to archive or inspect.

Output

The node outputs JSON data containing information about the archived resource inside the container. This typically includes metadata about the specified path (file or directory) and potentially the archive content if applicable.

If binary data is returned (e.g., the actual archive), it will be provided in the binary output field, representing the archived file or folder contents from the container’s filesystem.

Dependencies

  • Requires a valid Portainer API endpoint configured with appropriate credentials (an API key or token).
  • The node depends on the Portainer API being accessible at the specified URL and having permissions to interact with Docker endpoints and containers.
  • No additional external services are required beyond Portainer and Docker.

Troubleshooting

  • Invalid Endpoint or Credentials: If the endpoint ID is incorrect or credentials are missing/invalid, the node will fail to connect. Ensure the endpoint exists and credentials are correctly set.
  • Container Not Found: Specifying a wrong container ID or name will result in errors. Verify the container identifier is correct and the container is running.
  • Invalid Path: If the path inside the container does not exist or is inaccessible, the node may return an error or empty results. Double-check the path string.
  • API Rate Limits or Network Issues: Network connectivity problems or API rate limits on Portainer could cause failures. Check network status and API usage quotas.

Links and References

Discussion