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
System → Get Nodes
AI-generatedOverview
This node interacts with the Portainer API to retrieve information about Docker Swarm nodes within a specified environment. It is useful for managing and monitoring the nodes in a Docker Swarm cluster, such as listing all nodes or getting details about a specific node.
Use Case Examples
- Retrieve a list of all Docker Swarm nodes in an environment to monitor their status and resource usage.
- Get detailed information about a specific node by its ID to troubleshoot or manage the node's configuration.
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 node information retrieved from the Portainer API.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the environment ID is correctly specified to avoid 'not found' errors.
- If SSL validation errors occur, consider enabling 'Ignore SSL Issues' option if appropriate.
- Check proxy settings if requests fail to reach the Portainer API server.
- Timeout errors may occur if the server is slow; increase the timeout setting if needed.
Links
- Portainer System API Documentation - Official documentation for the Portainer system endpoints, including node management.