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
Node → Get Many
AI-generatedOverview
This node interacts with the Portainer API to retrieve a list of Docker Swarm nodes within a specified environment. It is useful for managing and monitoring the nodes in a Docker Swarm cluster through Portainer, allowing users to fetch details about all nodes available in the environment.
Use Case Examples
- Retrieve all Docker Swarm nodes in environment ID 1 to monitor cluster status.
- List all nodes to perform further operations like inspection or updates.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the environment/endpoint in Portainer where the nodes are managed. |
| Request Options | Settings to control request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration. |
Output
JSON
body- The JSON response body containing the list of nodes retrieved from the Portainer API.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the Environment ID is correct and corresponds to an existing Portainer environment.
- Check API key credentials and permissions to access node information.
- If SSL errors occur, consider enabling the option to ignore SSL certificate validation.
- Verify network connectivity and proxy settings if used.
Links
- Portainer API - Docker Nodes - Official Portainer API documentation for managing Docker Swarm nodes.