Actions107
- Node Actions
- Network Actions
- Container Actions
- Container List
- Container Create
- Container Inspect
- Container Top
- Container Logs
- Container Changes
- Container Export
- Container Stats
- Container Resize
- Container Start
- Container Stop
- Container Restart
- Container Kill
- Container Update
- Container Rename
- Container Pause
- Container Unpause
- Container Attach
- Container Attach Websocket
- Container Wait
- Container Delete
- Container Archive Info
- Container Archive
- Put Container Archive
- Container Prune
- Image Actions
- Volume Actions
- Swarm Actions
- Secret Actions
- System Actions
- Exec Actions
- Service Actions
- Task Actions
- Config Actions
- Plugin Actions
- Distribution Actions
- Session Actions
Overview
This node allows you to interact with Docker through the Portainer API, specifically focusing on inspecting Docker volumes. The "Volume Inspect" operation retrieves detailed information about a specific Docker volume by its name or ID within a selected Docker endpoint managed by Portainer.
Common scenarios for this node include:
- Retrieving metadata and configuration details of Docker volumes for monitoring or auditing.
- Automating infrastructure management workflows that require volume inspection data.
- Integrating volume information into dashboards or reports.
For example, you might use this node to fetch the properties of a volume before performing backup operations or to verify volume existence and attributes during deployment automation.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | Select the Docker endpoint (managed by Portainer) where the volume resides. You can choose from a list of available endpoints or specify an ID via expression. This determines which Docker environment the request targets. |
| Name | The name or ID of the Docker volume you want to inspect. This is required to identify the specific volume within the chosen endpoint. |
Output
The node outputs JSON data containing detailed information about the inspected Docker volume. This typically includes volume metadata such as its name, driver, mount point, labels, scope, and usage details as provided by the Portainer API.
No binary data output is indicated for this operation.
Dependencies
- Requires access to a Portainer instance managing Docker endpoints.
- Needs an API key credential for authenticating requests to the Portainer API.
- The node depends on the Portainer API being accessible at the URL specified in the credentials.
- The user must have appropriate permissions to query endpoints and inspect volumes via the Portainer API.
Troubleshooting
Common issues:
- Incorrect or missing endpoint selection may cause the node to fail to locate the Docker environment.
- Providing an invalid or non-existent volume name/ID will result in errors or empty responses.
- Network connectivity problems or incorrect Portainer API URL/credentials will prevent successful API calls.
Error messages:
- Authentication failures usually indicate invalid API credentials; verify and update them accordingly.
- "Volume not found" errors suggest the specified volume name/ID does not exist on the selected endpoint.
- Timeout or connection errors imply network issues or incorrect API endpoint URLs.
To resolve these, ensure the endpoint and volume identifiers are correct, credentials are valid, and the Portainer API is reachable.