Actions107
- Node Actions
- Network Actions
- 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
- Volume Actions
- Swarm Actions
- Secret Actions
- System Actions
- Exec Actions
- Service Actions
- Task Actions
- Config Actions
- Plugin Actions
- Distribution Actions
- Session Actions
Overview
This node allows users to interact with Docker through the Portainer API by targeting a specific Docker endpoint. The "System Ping Head" operation is designed to send a lightweight ping request (HEAD method) to check the availability or responsiveness of the Docker system at the specified endpoint. This can be useful for monitoring Docker environments, verifying connectivity before performing further actions, or integrating health checks into automation workflows.
Practical examples include:
- Verifying that a Docker endpoint is online before deploying containers.
- Periodically checking Docker system status as part of infrastructure monitoring.
- Triggering alerts or conditional logic in workflows based on Docker system availability.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier or name of the Docker endpoint to target. Choose from a list of available endpoints or specify an ID using an expression. |
Output
The node outputs JSON data representing the response headers and status from the ping HEAD request to the Docker system via the Portainer API endpoint. Since this is a HEAD request, no body content is returned; the output primarily confirms connectivity and server response status.
If the node supports binary data output, it would typically relate to raw HTTP response metadata, but in this case, the focus is on JSON metadata about the ping result.
Dependencies
- Requires access to a Portainer API instance with valid credentials (an API key or token).
- The node depends on the Portainer API being accessible at the URL configured in the credentials.
- The user must have at least one Docker endpoint registered in Portainer to select or specify.
Troubleshooting
- Common issues:
- Invalid or missing endpoint ID: Ensure the selected endpoint exists and is correctly specified.
- Network connectivity problems: Verify that the Portainer API URL is reachable from n8n.
- Authentication failures: Confirm that the provided API credentials are valid and have sufficient permissions.
- Error messages:
- HTTP 401 Unauthorized: Check API credentials and permissions.
- HTTP 404 Not Found: The specified endpoint ID does not exist.
- Timeout or network errors: Confirm network connectivity and Portainer API availability.