Actions86
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Environment Actions
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Setting Actions
- Stack Actions
- System Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Container → Get Many
AI-generatedOverview
This node operation retrieves a list of Docker containers from a specified environment in Portainer. It is useful for scenarios where you need to monitor, manage, or analyze multiple containers running in a Docker environment. For example, you can use it to get an overview of all containers, including their status and configuration, which helps in managing containerized applications efficiently.
Use Case Examples
- Listing all containers in a Docker environment to monitor their status.
- Retrieving container details to automate deployment or scaling processes.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the environment/endpoint in Portainer from which to retrieve containers. |
| Include All | Whether to include stopped containers in the listing. |
Output
JSON
- ``
Id- Unique identifier of the container.Names- Names assigned to the container.Image- Docker image used by the container.State- Current state of the container (e.g., running, stopped).Status- Status description of the container.
Dependencies
- Portainer API key credential for authentication and access to the Portainer environment.
Troubleshooting
- Ensure the Environment ID is correct and corresponds to an existing environment in Portainer.
- Verify that the API key credential is valid and has sufficient permissions to list containers.
- If no containers are returned, check the 'Include All' option to include stopped containers if needed.