Actions72
- Image Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Overview
This node integrates with the Portainer API to manage Docker environments and Docker Swarm resources programmatically. It allows users to perform various operations such as inspecting, listing, creating, updating, and deleting Docker entities like containers, images, volumes, networks, stacks, services, secrets, configs, and nodes.
Specifically, for the Node resource with the Inspect operation, the node fetches detailed information about a specific Docker Swarm node identified by its Node ID within a given Portainer environment. This is useful for administrators or automation workflows that need to retrieve metadata, status, or configuration details of individual nodes in a Docker Swarm cluster managed via Portainer.
Practical examples:
- Inspecting a node to check its current state, labels, availability, or role.
- Automating monitoring or auditing tasks by retrieving node details regularly.
- Integrating node inspection into deployment pipelines to verify cluster health before updates.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the Portainer environment/endpoint where the Docker Swarm node resides. |
| Node ID | The unique identifier of the Docker Swarm node to inspect. |
Output
The output contains a JSON object representing the detailed information of the specified Docker Swarm node as returned by the Portainer API. This includes all metadata and status fields available from the Docker API for nodes, such as:
- Node ID
- Description (hostname, platform, resources)
- Status (state, availability)
- Manager status (if applicable)
- Labels assigned to the node
- Version information
No binary data is produced by this operation.
Dependencies
- Requires an active connection to a Portainer instance with API access.
- Requires an API key credential configured in n8n to authenticate requests to the Portainer API.
- The Portainer environment ID must correspond to a valid endpoint configured in Portainer.
- The node ID must be valid within the specified environment.
Troubleshooting
- Invalid Environment ID or Node ID: If the IDs are incorrect or do not exist, the API will return an error indicating the resource was not found. Verify the IDs in Portainer.
- Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions to access node information.
- Network connectivity issues: Confirm that n8n can reach the Portainer API URL configured in credentials.
- API rate limits or timeouts: Large clusters or slow network may cause delays; consider retry mechanisms or pagination if listing multiple nodes.