mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, Container List Volumes, interacts with an API to retrieve a list of storage volumes associated with containerized environments. It is useful for users who need to manage or audit storage resources within specific projects or stacks in container orchestration platforms.

Typical use cases include:

  • Fetching all volumes related to a particular project to monitor storage usage.
  • Filtering volumes by search terms to quickly find specific storage units.
  • Sorting volumes by name or storage size to organize the output.
  • Paginating through large sets of volumes when dealing with many resources.

For example, a DevOps engineer might use this node to list all volumes in a project to check which ones are consuming the most space or to verify volume names before performing cleanup operations.

Properties

Name Meaning
Stack Id ID of the Stack to list Volumes for. Optional filter to narrow down volumes by stack.
Project Id Required. ID of the Project to list Volumes for. Specifies the project scope.
Search Term Search term to filter volumes by their searchable fields (e.g., name).
Sort Order Sorts the list by one of: Name Asc, Name Desc, Storage Asc, Storage Desc.
Limit Maximum number of volume records to return in the response. Defaults to 1000.
Skip Number of items to skip in the result set; used for pagination. Should be multiple of limit.
Page Page number to display. If both page and skip are set, skip takes precedence.

Output

The node outputs a JSON array containing volume objects that match the query parameters. Each object typically includes details such as volume name, size, associated project and stack IDs, and other metadata relevant to the volume resource.

If the API supports binary data for volumes (e.g., snapshots or backups), the node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON metadata about volumes.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The base URL for API requests is https://api.mittwald.de.
  • The node uses standard HTTP headers for JSON content negotiation (Accept: application/json, Content-Type: application/json).
  • No additional external dependencies beyond the API and n8n's HTTP request capabilities.

Troubleshooting

  • Missing or invalid Project Id: Since Project Id is required, omitting it will likely cause an error or empty response. Ensure this property is set correctly.
  • Pagination issues: Setting skip incorrectly (not a multiple of limit) may lead to unexpected results or errors. Use consistent pagination parameters.
  • API authentication errors: Invalid or missing API credentials will prevent successful API calls. Verify the API key credential configuration.
  • Empty results: Using overly restrictive search terms or filters may return no volumes. Try broadening search criteria.
  • Rate limiting or API downtime: If the API limits requests or is temporarily unavailable, the node may throw errors. Implement retry logic or check API status.

Links and References

Discussion