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 enables interaction with Docker through the Portainer API. Specifically, the "System Data Usage" operation under the "System" resource allows users to retrieve data usage statistics for Docker objects on a specified endpoint managed by Portainer. This is useful for monitoring and managing Docker resources such as containers, images, volumes, or networks in an automated workflow.
Practical scenarios include:
- Automating the collection of Docker system usage metrics for reporting or alerting.
- Integrating Docker resource usage data into dashboards or monitoring tools.
- Managing cleanup operations based on usage statistics.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Docker endpoint managed by Portainer to query. Users can select from a list of available endpoints or specify an ID directly. |
| Additional Fields | Optional additional parameters. Contains: - Type: JSON array specifying object types (e.g., containers, images) for which to compute and return data usage information. |
Output
The node outputs JSON data containing the system data usage statistics retrieved from the specified Docker endpoint via the Portainer API. The structure depends on the requested object types but generally includes usage metrics related to Docker objects such as storage size, counts, or other relevant statistics.
No binary data output is indicated.
Dependencies
- Requires access to a Portainer instance with its API enabled.
- 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 issues:
- Invalid or missing API credentials will cause authentication failures.
- Specifying an incorrect or unavailable endpoint ID will result in errors when querying the Portainer API.
- Improperly formatted JSON in the "Type" field may cause request failures.
Error messages:
- Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
- Endpoint not found errors suggest the selected endpoint does not exist or is inaccessible; confirm the endpoint ID.
- JSON parsing errors in additional fields require correcting the JSON syntax.