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
AI-generatedOverview
This node interacts with the Portainer API to retrieve information about Docker Swarm nodes. Specifically, the 'Get' operation for the 'Node' resource fetches details of a single node by its ID within a specified environment (endpoint) in Portainer. This is useful for managing and monitoring individual nodes in a Docker Swarm cluster, such as checking node status or configuration.
Use Case Examples
- Retrieve details of a specific Docker Swarm node by providing its Node ID and Environment ID in Portainer.
- Use case: Automate monitoring or management tasks for Docker Swarm nodes by integrating this node in workflows.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the environment/endpoint in Portainer where the node resides. Required to specify the context for the node operation. |
| Node ID | The unique identifier of the Docker Swarm node to retrieve. Required to specify which node to get details for. |
| Request Options | Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configuration to customize the API request behavior. |
Output
JSON
id- The unique identifier of the node.description- Detailed description and metadata of the node.status- Current status information of the node.spec- Specification details of the node including role and availability.
Dependencies
- Portainer API access with an API key credential
Troubleshooting
- Ensure the Environment ID and Node ID are correct and correspond to existing resources in Portainer.
- Check API key credentials and permissions to access node information.
- If SSL errors occur, consider enabling the 'Ignore SSL Issues' option if appropriate.
- Verify network connectivity to the Portainer API endpoint and proxy settings if used.