Portainer icon

Portainer

Work with Portainer API data to manage Docker

Actions86

Stack → Get Many

AI-generated

Overview

This node operation retrieves a list of Docker Compose stacks managed by Portainer. It is useful for scenarios where you need to fetch and display all stacks available in a given environment or endpoint within Portainer, such as for monitoring, reporting, or further automation tasks involving stack management.

Use Case Examples

  1. Listing all Docker Compose stacks in a specific environment to monitor their status.
  2. Fetching stacks to automate updates or backups based on the retrieved stack information.

Properties

Name Meaning
Environment ID The ID of the environment/endpoint in Portainer where the stacks are managed. This is required to specify the target environment for the stack retrieval.
Request Options Optional settings to control the request behavior, including batching of requests, SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • ``
    • Id - The unique identifier of each stack.
    • Name - The name of each stack.
    • EndpointId - The environment/endpoint ID associated with each stack.
    • CreationDate - The date and time when each stack was created.
    • StackFileContent - The content of the stack file (docker-compose.yml or equivalent) for each stack.

Dependencies

  • Portainer API with an API key credential for authentication

Troubleshooting

  • Ensure the Environment ID is correct and the Portainer endpoint is accessible.
  • Check API key permissions to confirm they allow reading stack information.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option if appropriate.
  • Verify proxy settings if a proxy is required for network access.

Links

Discussion