Overview

This node operation retrieves a list of Docker volumes from a specified environment in Portainer. It is useful for managing and monitoring Docker volumes within different environments/endpoints. For example, a user can list all volumes to check storage usage or to identify unused volumes for cleanup.

Use Case Examples

1. List all Docker volumes in environment ID 1 to monitor storage usage.
2. Retrieve volumes to automate backup or cleanup processes in a Docker environment managed by Portainer.

Properties

Output

JSON

• volumes
  • Name - Name of the Docker volume.
  • Driver - Driver used by the Docker volume.
  • Mountpoint - Mount point path of the Docker volume.
  • Labels - Labels associated with the Docker volume.
  • Scope - Scope of the Docker volume (e.g., local, global).

Dependencies

• Portainer API with an API key credential for authentication

Troubleshooting

• Ensure the Environment ID is correct and the environment is accessible in Portainer.
• Check that the API key credential is valid and has sufficient permissions to list volumes.
• If SSL issues occur, consider enabling the option to ignore SSL certificate validation, especially in self-signed certificate environments.
• Verify proxy settings if a proxy is required for network access to the Portainer API.

Links

• Portainer API - Volumes - Official Portainer API documentation for managing Docker volumes.