Actions88
- Container Actions
- Container List
- Container Create
- Container Inspect
- Container Top
- Container Logs
- Container Changes
- Container Export
- Container Stats
- Container Resize
- Container Start
- Container Stop
- Container Restart
- Container Kill
- Container Update
- Container Rename
- Container Pause
- Container Unpause
- Container Attach
- Container Attach Websocket
- Container Wait
- Container Delete
- Container Archive Info
- Container Archive
- Put Container Archive
- Container Prune
- Image Actions
- Network Actions
- Volume Actions
- Swarm Actions
- Node Actions
- Secret Actions
- System Actions
- Exec Actions
- Service Actions
- Task Actions
Overview
This node enables interaction with Docker through the Portainer API. Specifically, the "System Ping" operation under the "System" resource allows users to check the connectivity and responsiveness of a Docker endpoint managed by Portainer. This is useful for verifying that the Docker environment is accessible and operational before performing further actions.
Practical scenarios include:
- Monitoring Docker endpoints to ensure they are online.
- Validating connection settings in automated workflows.
- Troubleshooting connectivity issues with Docker hosts managed via Portainer.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Docker endpoint to access via Portainer. Choose from the list or specify an ID using an expression. |
Output
The node outputs JSON data representing the response from the Portainer API's system ping endpoint. This typically includes status information confirming whether the Docker endpoint is reachable and responsive.
No binary data output is involved.
Dependencies
- Requires an active Portainer API instance.
- Needs an API authentication token credential configured in n8n to authenticate requests to the Portainer API.
- The node dynamically loads available Docker endpoints from Portainer to populate the endpoint selection property.
Troubleshooting
Common Issue: Failure to connect to the specified Docker endpoint.
- Cause: Incorrect endpoint ID, network issues, or Portainer API not reachable.
- Resolution: Verify the endpoint ID is correct and that the Portainer server URL and credentials are properly configured.
Error Messages:
- Authentication errors indicate invalid or missing API credentials.
- Network errors suggest connectivity problems between n8n and the Portainer API.
Ensure the Portainer API URL and credentials are correctly set in the node configuration.