Portainer icon

Portainer

Interact with Portainer via API

Actions190

Stacks → Stack List

AI-generated

Overview

This node operation lists stacks from a Portainer environment. It is useful for retrieving an overview of all stacks managed by Portainer, which can be helpful in scenarios such as monitoring deployments, auditing stack configurations, or integrating stack data into other workflows.

For example, you might use this node to fetch all stacks associated with a specific Swarm cluster to automate deployment reports or trigger alerts based on stack status.

Properties

Name Meaning
Additional Fields A collection of optional fields to customize the stack list request. Currently supports:
- Filters JSON-encoded string representing key-value pairs to filter the stacks returned. For example, {"SwarmID": "jpofkc0i9uo9wtx1zesuk649w"} filters stacks belonging to that Swarm cluster. Available filters include EndpointID and SwarmID.

Output

The node outputs a JSON array containing stack objects retrieved from Portainer. Each object represents a stack with its properties as defined by the Portainer API. The exact structure depends on the API response but typically includes identifiers, names, and metadata about each stack.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to a Portainer API endpoint.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the Portainer API must be set in the credentials.

Troubleshooting

  • Invalid Filters Format: If the filters property is not a valid JSON string, the API request may fail or return no results. Ensure filters are properly JSON-encoded.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key/token and URL are correctly configured.
  • Network Issues: Connectivity problems to the Portainer server will prevent data retrieval. Check network access and firewall settings.
  • Empty Results: Using overly restrictive filters may result in no stacks being returned. Try removing or adjusting filters to broaden the query.

Links and References

Discussion