Portainer icon

Portainer

Interact with Portainer via API

Actions190

Kubernetes → Get All Kubernetes Volumes

AI-generated

Overview

This node operation retrieves all Kubernetes volumes from a specified environment. It is useful for users who want to list and inspect the storage volumes available in their Kubernetes clusters. A common scenario includes auditing storage usage, managing persistent volumes, or integrating volume information into automation workflows.

For example, a DevOps engineer might use this node to fetch all volumes in a cluster to monitor which applications are using them or to prepare for scaling or migration tasks.

Properties

Name Meaning
Id Environment identifier (number) specifying which Kubernetes environment to query.
Additional Fields Optional extra parameters:
- With Applications Boolean flag indicating whether to include the applications that are using the volumes. Defaults to true.

Output

The node outputs JSON data representing the list of Kubernetes volumes retrieved from the specified environment. If the "With Applications" option is enabled, the output will also include details about the applications associated with each volume.

The structure typically includes volume metadata such as volume names, IDs, status, capacity, and optionally, linked application information.

No binary data output is involved.

Dependencies

  • Requires an API key credential to authenticate requests to the Kubernetes environment management API.
  • The node depends on the Portainer API (or similar Kubernetes management API) endpoint configured via credentials.
  • Proper network access to the Kubernetes environment's API server is necessary.

Troubleshooting

  • Common issues:
    • Invalid or missing environment identifier (Id) can cause the request to fail.
    • Network connectivity problems to the Kubernetes API endpoint.
    • Insufficient permissions or invalid API credentials may result in authorization errors.
  • Error messages:
    • Authentication failures usually indicate incorrect or expired API keys; verify and update credentials.
    • "Environment not found" errors suggest the provided Id does not correspond to any known environment.
    • Timeout or connection errors imply network issues; check firewall and API availability.

Links and References

Discussion