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
Environment → Get Many
AI-generatedOverview
This node interacts with the Portainer API to retrieve a list of all environments (endpoints) available in the Portainer instance. It is useful for scenarios where you need to manage or monitor multiple Docker environments through Portainer, such as listing all Docker endpoints for further automation or reporting.
Use Case Examples
- Retrieve all environments to display in a dashboard.
- Fetch environments to automate deployment or monitoring tasks across multiple Docker endpoints.
Properties
| Name | Meaning |
|---|---|
| Request Options | Options to customize the API request behavior, including batching, SSL certificate validation, proxy settings, and request timeout. |
Output
JSON
body- The JSON response body containing the list of environments retrieved from the Portainer API.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the API key credential is correctly configured and has permissions to access environment data.
- If SSL errors occur, consider enabling the option to ignore SSL certificate validation, especially in self-signed certificate environments.
- Check network connectivity and proxy settings if requests fail or time out.
- Common error messages include authentication failures (401 Unauthorized) and request timeouts; verify credentials and increase timeout settings if needed.
Links
- Portainer API Endpoints Documentation - Official documentation for Portainer API endpoints, including environment management.